Files
Enterprise-Knowledge-Base/cli/cmd/session/tool_approval.go
T
nullkey d3c03b2f34 feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.

Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
  name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
  "no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
  stream sets Done=true on an intermediate agent_query frame before the answer,
  and AgentAccumulator treated the first Done as terminal. Terminate on the
  `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
  including `doc upload --recursive` partial failures — a permanent per-file
  failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
  would loop on; per-item typed errors stay in the envelope.

Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
  input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
  on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
  retrieval_ready, and kb create hints the fix when no embedding model is bound
  — an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
  (drift-guarded); output strings match the meta actually emitted; chunk list
  and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
  `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
  path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
  accept and ignore it, declared in schema) so a carried-over --kb doesn't
  exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.

Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
  has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
  expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
  (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
  model.update / kb.config.set) and batch example (failed item carries `error`);
  session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
  prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
  give an env-aware message instead of looping on "run auth login". `auth logout`
  clears credentials but keeps the profile registered (host preserved for
  re-login); deleting a profile is `profile remove`'s job (clean logout/remove
  separation, matching gh / lark).

Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
  reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
  rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.

Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
2026-07-06 22:53:01 +08:00

220 lines
7.7 KiB
Go

package sessioncmd
import (
"context"
"encoding/json"
"fmt"
"github.com/spf13/cobra"
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
"github.com/Tencent/WeKnora/cli/internal/iostreams"
"github.com/Tencent/WeKnora/cli/internal/prompt"
sdk "github.com/Tencent/WeKnora/client"
)
var resolveFields = []string{"pending_id", "decision", "resolved"}
// decision values sent to the server and surfaced in the result/dry-run JSON.
const (
decisionApprove = "approve"
decisionReject = "reject"
)
// ResolveOptions holds the parsed flags and positional argument for
// `session tool-approval resolve`.
type ResolveOptions struct {
PendingID string
Reject bool
Reason string
ModifiedArgs string
Yes bool
DryRun bool
}
// ResolveService is the narrow SDK surface this command depends on.
type ResolveService interface {
ResolveToolApproval(ctx context.Context, pendingID string, req *sdk.ResolveToolApprovalRequest) error
}
type resolveResult struct {
PendingID string `json:"pending_id"`
Decision string `json:"decision"`
Resolved bool `json:"resolved"`
}
const resolveLong = `Resolve a pending tool approval raised during an agent run.
When a server-side agent run (weknora session ask) needs to call a tool
that requires approval, the stream emits a tool-approval event carrying a
pending id and the run blocks. This command unblocks it: approve (default)
lets the tool call execute, --reject cancels it. After resolving, resume
the answer with weknora session resume.
--modified-args replaces the tool call arguments on approve (JSON object).
It conflicts with --reject (rejected calls never execute).
AI agents: approving a tool call is the human-approval step itself — that
is exactly what the exit-10 protocol guards. Without -y/--yes the CLI
exits 10 and writes input.confirmation_required to stderr. Surface the
pending tool call to the user and only pass -y after their explicit
go-ahead.`
// NewCmdToolApproval builds the `session tool-approval` subtree.
func NewCmdToolApproval(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "tool-approval",
Short: "Resolve pending tool approvals from agent runs",
}
cmd.AddCommand(newCmdResolve(f))
return cmd
}
func newCmdResolve(f *cmdutil.Factory) *cobra.Command {
opts := &ResolveOptions{}
cmd := &cobra.Command{
Use: "resolve <pending-id>",
Short: "Approve or reject a pending tool call (high-risk write)",
Long: resolveLong,
Example: ` weknora session tool-approval resolve pend_abc -y # approve
weknora session tool-approval resolve pend_abc --reject --reason "wrong target" -y
weknora session tool-approval resolve pend_abc -y --format json`,
Args: cobra.ExactArgs(1),
RunE: func(c *cobra.Command, args []string) error {
fopts, err := cmdutil.CheckFormatFlag(c)
if err != nil {
return err
}
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
opts.PendingID = args[0]
opts.Yes, _ = c.Flags().GetBool("yes")
// Validate inputs BEFORE the dry-run gate so --dry-run previews a
// valid action — an invalid --modified-args (e.g. "{}") must error
// the same way whether or not --dry-run is passed.
if _, err := validateModifiedArgs(opts); err != nil {
return err
}
dryRunArgs := map[string]any{
"pending_id": opts.PendingID,
"decision": decisionOf(opts.Reject),
"reason": opts.Reason,
}
if opts.ModifiedArgs != "" {
dryRunArgs["modified_args"] = opts.ModifiedArgs
}
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
Action: "session.tool_approval.resolve",
Args: dryRunArgs,
}); handled {
return err
}
cli, err := f.Client()
if err != nil {
return err
}
return runResolve(c.Context(), opts, fopts, cli, f.Prompter())
},
}
cmd.Flags().BoolVar(&opts.Reject, "reject", false, "Reject the pending tool call instead of approving")
cmd.Flags().StringVar(&opts.Reason, "reason", "", "Reason recorded with the decision")
cmd.Flags().StringVar(&opts.ModifiedArgs, "modified-args", "", "Replace tool call arguments on approve (JSON object; conflicts with --reject)")
cmdutil.AddFormatFlag(cmd, resolveFields...)
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
cmdutil.SetRisk(cmd, "session.tool_approval.resolve")
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
UsedFor: "approve or reject a pending tool call from an agent run; then resume with session resume",
RequiredFlags: []string{"<pending-id> (positional)"},
Examples: []string{
"weknora session tool-approval resolve pend_abc -y",
"weknora session tool-approval resolve pend_abc --reject -y",
},
Output: "envelope.data is {pending_id, decision (approve|reject), resolved:true}",
Warnings: []string{
"Requires explicit user approval (exit 10 / input.confirmation_required); never auto-add -y.",
"Approving executes the blocked tool call with the user's authority — show the user what tool/args are pending before resolving.",
},
})
return cmd
}
func decisionOf(reject bool) string {
if reject {
return decisionReject
}
return decisionApprove
}
// decisionPastTense returns the past tense of the decision verb for human output.
func decisionPastTense(decision string) string {
switch decision {
case decisionReject:
return "Rejected"
default: // decisionApprove
return "Approved"
}
}
// retryArgOf returns the extra --reject flag element to include in the retry
// argv when the decision is reject; nil otherwise.
func retryArgOf(reject bool) []string {
if reject {
return []string{"--reject"}
}
return nil
}
// validateModifiedArgs checks the --reject/--modified-args invariants and
// returns the validated raw JSON (nil when --modified-args is unset). Shared
// by the RunE pre-dry-run gate and runResolve so both paths reject the same
// inputs identically.
func validateModifiedArgs(opts *ResolveOptions) (json.RawMessage, error) {
if opts.Reject && opts.ModifiedArgs != "" {
return nil, &cmdutil.Error{
Code: cmdutil.CodeInputInvalidArgument,
Message: "--modified-args conflicts with --reject (rejected calls never execute)",
}
}
if opts.ModifiedArgs == "" {
return nil, nil
}
var probe map[string]any
if err := json.Unmarshal([]byte(opts.ModifiedArgs), &probe); err != nil || probe == nil {
return nil, &cmdutil.Error{
Code: cmdutil.CodeInputInvalidArgument,
Message: "--modified-args must be a non-null JSON object",
}
}
if len(probe) == 0 {
return nil, &cmdutil.Error{
Code: cmdutil.CodeInputInvalidArgument,
Message: "--modified-args must not be an empty object (it would wipe the original tool arguments); omit the flag to keep them",
}
}
return json.RawMessage(opts.ModifiedArgs), nil
}
func runResolve(ctx context.Context, opts *ResolveOptions, fopts *cmdutil.FormatOptions, svc ResolveService, p prompt.Prompter) error {
modified, err := validateModifiedArgs(opts)
if err != nil {
return err
}
decision := decisionOf(opts.Reject)
retryCmd := append([]string{"weknora", "session", "tool-approval", "resolve", opts.PendingID}, retryArgOf(opts.Reject)...)
retryCmd = append(retryCmd, "-y")
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), decision, "tool call", opts.PendingID, "session.tool_approval.resolve", retryCmd); err != nil {
return err
}
if err := svc.ResolveToolApproval(ctx, opts.PendingID, &sdk.ResolveToolApprovalRequest{
Decision: decision,
Reason: opts.Reason,
ModifiedArgs: modified,
}); err != nil {
return cmdutil.WrapHTTP(err, "resolve tool approval %s", opts.PendingID)
}
if fopts.WantsJSON() {
return fopts.Emit(iostreams.IO.Out, resolveResult{PendingID: opts.PendingID, Decision: decision, Resolved: true}, nil)
}
fmt.Fprintf(iostreams.IO.Out, "✓ %s tool call %s\n", decisionPastTense(decision), opts.PendingID)
return nil
}