Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

409 pages for schema.

Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.

skills Claude Developer Platform · in the page managed-agents/skills …ills-guide#managing-custom-skills). For the full request and response schemas, see the [Create Skill](https://platform.claude.com/docs/en/api/skills/create) API reference. Skill bundles upload directl… tools Claude Developer Platform · in the page managed-agents/tools …"description": "Get current weather for a location", "input_schema": { "type": "object", "properties": { "location": {"type": "string", "description": "… vaults Claude Developer Platform · in the page managed-agents/vaults …/service_accounts.yaml"> ```yaml # yaml-language-server: $schema=https://platform.claude.com/schemas/ant/beta/vault.json display_name: Service accounts ``` </File> [`a… Or, for Claude Mythos 5.1, which offers the same capabilities to verified organizations: Claude Developer Platform · in the page models/fable-5-1/migration-guide …"Record the structured summary of the document.", "input_schema": { "type": "object", "properties": {"summary": {"type": "string"}}, "required… whats-new-fable-5-1 Claude Developer Platform · in the page models/fable-5-1/whats-new-fable-5-1 …t into the tool arguments instead, which lowers argument quality. For schema-valid JSON, keep `tool_choice: {"type": "auto"}` and set `strict: true` with [strict tool use](https://platform.claude.com/… migration-guide Claude Developer Platform · in the page models/opus-5-5/migration-guide …rompt when the tool applies. Strict tool use accepts a subset of JSON Schema, so check each tool's `input_schema` before you add `strict: true`. Every object in the schema must set `additionalProperti… whats-new-opus-5-5 Claude Developer Platform · in the page models/opus-5-5/whats-new-opus-5-5 …rm.claude.com/docs/en/build-with-claude/token-counting) endpoint. For schema-valid JSON, keep `tool_choice: {"type": "auto"}` and set `strict: true` with [strict tool use](https://platform.claude.com/… migration-guide Claude Developer Platform · in the page models/sonnet-5-5/migration-guide …: "auto"}`, and mark the tool `strict: true` so its input matches the schema. The model can then answer without calling the tool, so say in the prompt when to use it. [Strict tool use](https://platfor… whats-new-sonnet-5-5 Claude Developer Platform · in the page models/sonnet-5-5/whats-new-sonnet-5-5 …rm.claude.com/docs/en/build-with-claude/token-counting) endpoint. For schema-valid tool input, keep `tool_choice: {"type": "auto"}` and set `strict: true` with [strict tool use](https://platform.claud… overview Claude Developer Platform · in the page release-notes/overview …efinition", "definition": {...}}`), so you can add a tool, change its schema, or move a server tool to a newer version without editing `tools` or invalidating the prompt cache. The same header covers… increase-consistency Claude Developer Platform · in the page test-and-evaluate/strengthen-guardrails/increase-consistency …nd grounding answers in retrieval. --- <Tip> **For guaranteed JSON schema conformance** If you need Claude to always output valid JSON that conforms to a specific schema, use [Structured Outputs… mitigate-jailbreaks Claude Developer Platform · in the page test-and-evaluate/strengthen-guardrails/mitigate-jailbreaks …or explicit activities. ``` Use `output_config` with a JSON schema to constrain the response: ```json { "output_config": { "format": { "type": "json_schema",… How the agent loop works Claude Code CLI · in the page agent-sdk/agent-loop …(/docs/en/agent-sdk/mcp.md#mcp-tool-search) defers by default | Every schema loads upfront in the cases under [Configure tool search](/docs/en/agent-sdk/tool-search.md#configure-tool-search) | | **Con… Configure your agent Claude Code CLI · in the page agent-sdk/configuration …` reference](/docs/en/agent-sdk/typescript#applyflagsettings) for the schema and for which keys take effect mid-session. * **`updateSettings()`**: writes one allowlisted key to a settings file. The [`… Give Claude custom tools Claude Code CLI · in the page agent-sdk/custom-tools …/en/agent-sdk/typescript#tool) (TypeScript) with a name, description, schema, and handler. See [Create a custom tool](#create-a-custom-tool). | | Make a parameter optional | Declare it optional in the… Intercept and control agent behavior with hooks Claude Code CLI · in the page agent-sdk/hooks …aude Code hooks reference](/docs/en/hooks.md): full JSON input/output schemas, event documentation, and matcher patterns * [Claude Code hooks guide](/docs/en/hooks-guide.md): shell command hook exampl… Connect to external tools with MCP Claude Code CLI · in the page agent-sdk/mcp …same cap for that server's tools, so the first turn has them at full schema, [exempt from tool search deferral](/docs/en/mcp.md#exempt-a-server-from-deferral). A remote server with a cached tool list… Agent SDK reference - Python Claude Code CLI · in the page agent-sdk/python …theme={null} def tool( name: str, description: str, input_schema: type | dict[str, Any], annotations: ToolAnnotations | None = None ) -> Callable[[Callable[[Any], Awaitable[dict[str, A… Get structured output from agents Claude Code CLI · in the page agent-sdk/structured-outputs …from agents > Return validated JSON from agent workflows using JSON Schema, Zod, or Pydantic. Get type-safe, structured data after multi-turn tool use. Structured outputs let you define the exact s… Subagents in the SDK Claude Code CLI · in the page agent-sdk/subagents …llowedTools` to auto-approve workflow runs. The tool input and output schemas are listed in the [TypeScript reference](/docs/en/agent-sdk/typescript.md#workflow). ## Troubleshooting ### Claude not d… Track todos Claude Code CLI · in the page agent-sdk/todo-tracking …ript](/docs/en/agent-sdk/typescript.md): the options, types, and tool schemas for the TypeScript SDK, including the Task tool input and output types * [Agent SDK reference - Python](/docs/en/agent-sdk… Troubleshoot the Agent SDK Claude Code CLI · in the page agent-sdk/troubleshooting …Usage Policy refusal](/docs/en/errors.md#usage-policy-refusal). * **A schema no output can satisfy**: for example, a string whose `minLength` is greater than its `maxLength`. If `structured_output` is… Agent SDK reference - TypeScript Claude Code CLI · in the page agent-sdk/typescript …r use with SDK MCP servers. ```typescript theme={null} function tool<Schema extends AnyZodRawShape>( name: string, description: string, inputSchema: Schema, handler: (args: InferShape<Schema>… Handle approvals and user input Claude Code CLI · in the page agent-sdk/user-input …_path`, `offset`, `limit` | See the SDK reference for complete input schemas: [Python](/docs/en/agent-sdk/python.md#tool-input%2Foutput-types) | [TypeScript](/docs/en/agent-sdk/typescript.md#tool-inp… Manage multiple agents with agent view Claude Code CLI · in the page agent-view …ToolUse` hook printed an invalid answer [names the hook event and the schema error on its row](#peek-and-reply). Before this release, the row showed only the pending request. | | v2.1.248 | On Windows… Claude Code on Amazon Bedrock Claude Code CLI · in the page amazon-bedrock …ontext` command counts tokens for each tool group by sending the tool schemas to the Amazon Bedrock count-tokens API. On Claude Code versions before v2.1.196, Amazon Bedrock rejected that request beca… Share session output as artifacts Claude Code CLI · in the page artifacts …ce/apps/code/artifacts/{artifact_id}` | For the request and response schemas, see the [Compliance API reference](https://platform.claude.com/docs/en/api/compliance/apps/code/artifacts). ## Related r… Claude Code changelog Claude Code CLI · in the page changelog …ed `claude --help` text for `--tools`, `--resume`, `--debug`, `--json-schema`, `--disable-slash-commands`, `--system-prompt-snapshot` and `claude update` to match actual behavior * Fixed `claude --wor… Channels reference Claude Code CLI · in the page channels-reference …laude Code discovers the tool 2. Tool handlers that define the tool's schema and implement the send logic 3. An `instructions` string in your `Server` constructor that tells Claude when and how to cal… Claude apps gateway for Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry Claude Code CLI · in the page claude-apps-gateway …later. The smallest managed tier is enough. The gateway runs its own schema migrations at boot, so the database role needs rights to create and alter tables; see [`store`](/docs/en/claude-apps-gatewa… Claude apps gateway configuration Claude Code CLI · in the page claude-apps-gateway-config …--config /path/to/gateway.yaml`. Every option is validated against a schema at boot, so a malformed config fails at start with a field-level error rather than at first use. The [complete example](#c… Claude apps gateway deployment and operations Claude Code CLI · in the page claude-apps-gateway-deploy …its.md) configured, only `kv` is written. The gateway applies its own schema migrations at boot and on every upgrade, so its database role needs rights to create and alter tables. Point it at a databa… Claude apps gateway spend limits Claude Code CLI · in the page claude-apps-gateway-spend-limits …anizations/spend_limits/effective` returns Anthropic's `SpendSummary` schema: each row is a principal for a period, with the resolved cap, period-to-date spend, and an `actor` object. Gateway-specific… Explore the .claude directory Claude Code CLI · in the page claude-directory …team', when: <>Servers connect when the session begins. Tool schemas are deferred by default and load on demand via <A href="/docs/en/mcp#scale-with-mcp-tool-search">tool search</A></>,… claude-tag Claude Code CLI · in the page claude-tag …1 lg:min-w-0"><script type="application/ld+json">{"@context":"https://schema.org","@graph":[{"@type":"Organization","@id":"https://claude.com/#organization","name":"Claude.ai Documentation","url":"htt… CLI reference Claude Code CLI · in the page cli-reference …rmat stream-json` | | `--json-schema` | Get validated JSON output matching a JSON Schema after the agent completes its workflow… Configure cloud environments Claude Code CLI · in the page cloud-environments …*.packagecloud.io > * fonts.googleapis.com > * fonts.gstatic.com > **Schema and configuration** > > * json-schema.org > * [www.json-schema.org](http://www.json-schema.org) > * json.schemastore.org >… Common workflows Claude Code CLI · in the page common-workflows …using it? ``` ```text wrap theme={null} This is our current database schema. How should we modify it for the new feature? ``` **4. Get code suggestions from visual content** ```text wrap theme={nul… Explore the context window Claude Code CLI · in the page context-window …tool names listed so Claude knows what is available. By default, full schemas stay deferred and Claude loads specific ones on demand via tool search when a task needs them. Set `ENABLE_TOOL_SEARCH=aut… Message your other Claude Code sessions Claude Code CLI · in the page cross-session-messaging …t with a mention: ```text wrap theme={null} Let @api-worker know the schema migration finished ``` The typeahead lists your other live sessions on this machine. Two cases need more than the first le… Desktop application Claude Code CLI · in the page desktop …hat did the API session conclude?", or "tell the payments session the schema changed". You can also ask Claude to rename or archive a session. For example, ask it to archive the sessions whose PRs ha… Environment variables Claude Code CLI · in the page env-vars …rip Anthropic-specific `anthropic-beta` request headers and beta tool-schema fields (such as `defer_loading` and `eager_input_streaming`) from API requests. Use this when a proxy gateway rejects reque… Error reference Claude Code CLI · in the page errors …nputs-are-not-permitted) | | `API Error: 400 ... tools.N.custom.input_schema: JSON schema is invalid` / `Property keys should match pattern` | [Request errors](#tool-input-schema-is-invalid) | | `Tool… Extend Claude Code Claude Code CLI · in the page features-overview …an trigger with `/<name>`. A skill might include your team's database schema and query patterns, or a `/post-to-slack` workflow with your team's message formatting rules. **Hook vs Skill** Claude Co… Claude Code with GitHub Enterprise Server Claude Code CLI · in the page github-enterprise-server …erence.md#extraknownmarketplaces) settings reference for the complete schema. ## Limitations A few features behave differently on GHES than on github.com. The [feature table](#what-works-with-github… Glossary Claude Code CLI · in the page glossary …### MCP Tool Search A context-saving mechanism that defers MCP tool schemas until needed. Only tool names and server instructions load at startup; Claude fetches the full schema on demand when it de… Run Claude Code programmatically Claude Code CLI · in the page headless …ect" --output-format json ``` To get output conforming to a specific schema, use `--output-format json` with `--json-schema` and a [JSON Schema](https://json-schema.org/) definition. The response inc… Hooks reference Claude Code CLI · in the page hooks …oks reference > Reference for Claude Code hook events, configuration schema, JSON input/output formats, exit codes, async hooks, HTTP hooks, prompt hooks, and MCP tool hooks. > [!TIP] > > For a quic… Automate actions with hooks Claude Code CLI · in the page hooks-guide …guide covers common use cases and how to get started. For full event schemas, JSON input/output formats, and advanced features like async hooks and MCP tool hooks, see the [Hooks reference](/docs/en/… Customize keyboard shortcuts Claude Code CLI · in the page keybindings …hout restarting Claude Code. | Field | Description | | :- | :- | | `$schema` | Optional JSON Schema URL for editor autocompletion | | `$docs` | Optional documentation URL | | `bindings` | Array of bi…
Feedback