From ea650124a9866aa0961f6ccc2ed380f6db607f17 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 12:33:49 +0000 Subject: [PATCH 1/3] docs(rig): add JSDoc to all AgentSpec fields MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Document model, maxTurns, addons, agents, systemMessage, tools, input, output, instructions, and name — clarifying defaults and usage intent for each option. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- skills/rig/rig.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/skills/rig/rig.ts b/skills/rig/rig.ts index c306219..53e3bc1 100644 --- a/skills/rig/rig.ts +++ b/skills/rig/rig.ts @@ -476,15 +476,25 @@ export function defineTool(name: string, config: ToolConfig): To } export type AgentSpec = { + /** Human-readable name used in error messages and JSONL event logs. Defaults to `"agent"`. */ name?: string; + /** Natural-language task description rendered into the `` prompt section. */ instructions?: string | PromptBuilder; + /** Schema describing the agent's input value. Defaults to `s.string`. */ input?: Input; + /** Schema describing the agent's expected output. The harness validates and retries until it matches. Defaults to `s.string`. */ output?: Output; + /** Model identifier passed to the engine, e.g. `"mini"`, `"gpt-4.1"`, `"claude-sonnet"`. Defaults to `"gpt-4.1"`. */ model?: string; + /** Maximum number of turns (initial + repair retries). Defaults to `4`. */ maxTurns?: number; + /** Middleware addons that wrap each turn's ask/response cycle, e.g. `repair`, `steering`. */ addons?: AgentAddon | AgentAddon[]; + /** Named sub-agents available for delegation from this agent's prompt. */ agents?: Record>; + /** Optional system message forwarded to the underlying engine session. */ systemMessage?: unknown; + /** Tool definitions exposed to the engine session for function-calling. */ tools?: Tool[]; }; /** Internal normalized variant with a guaranteed resolved name. */ From a7122f88f1b5931e86df78f6f4836d1e3cac29bb Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 23 Jul 2026 12:44:18 +0000 Subject: [PATCH 2/3] docs(rig): replace deprecated gpt-4.1 example in model JSDoc Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- skills/rig/rig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skills/rig/rig.ts b/skills/rig/rig.ts index 53e3bc1..0a5ccc3 100644 --- a/skills/rig/rig.ts +++ b/skills/rig/rig.ts @@ -484,7 +484,7 @@ export type AgentSpec Date: Thu, 23 Jul 2026 12:46:02 +0000 Subject: [PATCH 3/3] docs(rig): use gpt-5 as model example in AgentSpec JSDoc Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- skills/rig/rig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skills/rig/rig.ts b/skills/rig/rig.ts index 0a5ccc3..6268494 100644 --- a/skills/rig/rig.ts +++ b/skills/rig/rig.ts @@ -484,7 +484,7 @@ export type AgentSpec