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

45 pages for readonly.

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

content-moderation Claude Developer Platform · in the page about-claude/use-case-guides/content-moderation …, string? Explanation)> ModerateMessage( string message, IReadOnlyList<string> categories ) { // Convert the unsafe categories into a string, with each category on a new line… customer-support-chat Claude Developer Platform · in the page about-claude/use-case-guides/customer-support-chat …py values defined // earlier in this guide (shown in Python). readonly anthropic = new Anthropic(); readonly messages: Anthropic.MessageParam[] = []; async generateMessage( mess… legal-summarization Claude Developer Platform · in the page about-claude/use-case-guides/legal-summarization …); async Task<string> SummarizeDocument( string text, IReadOnlyList<string> detailsToExtract, Model model = Model.ClaudeOpus5_5, long maxTokens = 16000 ) { // Form… advisor-tool Claude Developer Platform · in the page agents-and-tools/tool-use/advisor-tool …for each tool_use block. List<BetaContentBlockParam> RunYourTools(IReadOnlyList<BetaContentBlock> content) { List<BetaContentBlockParam> results = []; foreach (var block in content)… browser-use-tool Claude Developer Platform · in the page agents-and-tools/tool-use/browser-use-tool …ultBlockParamContent HandleBrowserAction( string action, IReadOnlyDictionary<string, JsonElement> input ) => action switch { "navigate" => Navigate(input["url"].Get… computer-use-tool Claude Developer Platform · in the page agents-and-tools/tool-use/computer-use-tool …aramContent HandleComputerAction( string action, IReadOnlyDictionary<string, JsonElement> input ) => action switch { "screenshot" => Capture… text-editor-tool Claude Developer Platform · in the page agents-and-tools/tool-use/text-editor-tool …} ``` ```csharp C# static string HandleEditorTool(IReadOnlyDictionary<string, JsonElement> input) { input.TryGetValue("command", out var commandEl); input.… claude-platform-on-aws-iam-actions Claude Developer Platform · in the page api/claude-platform-on-aws-iam-actions …h reading batch metadata and downloading batch results. The `AnthropicReadOnlyAccess`, `AnthropicInferenceAccess`, and `AnthropicLimitedAccess` policies' `Get*` wildcards include this action. </Note>… claude-platform-on-aws Claude Developer Platform · in the page build-with-claude/claude-platform-on-aws …AWS provides five managed policies (`AnthropicFullAccess`, `AnthropicReadOnlyAccess`, `AnthropicInferenceAccess`, `AnthropicLimitedAccess`, and `AnthropicSelfHostedEnvironmentAccess`) for common acce… mid-conversation-effort-example Claude Developer Platform · in the page build-with-claude/mid-conversation-effort-example …in flight at once. async function mapWithLimit<In, Out>( items: readonly In[], limit: number, task: (item: In) => Promise<Out> ): Promise<Out[]> { const results = new Array<Out>(it… inference-hooks-endpoint Claude Developer Platform · in the page manage-claude/inference-hooks-endpoint …/// </summary> public static bool Verify(string secret, IReadOnlyDictionary<string, string> headers, byte[] body) { // TryAdd keeps the first value if a proxy delivered ca… aws Claude Developer Platform · in the page manage-claude/wif-providers/aws …class StsTokenProvider : IIdentityTokenProvider { private readonly AmazonSecurityTokenServiceClient _sts = new(Amazon.RegionEndpoint.USEast1); public async Task<string> GetIdentityT… Create the app registration that represents the Claude API audience. Claude Developer Platform · in the page manage-claude/wif-providers/azure …ivate const string Audience = "api://<APP_ID>"; private static readonly HttpClient httpClient = new(); public async Task<string> GetIdentityTokenAsync(CancellationToken ct = default)… gcp Claude Developer Platform · in the page manage-claude/wif-providers/gcp …udience=https://api.anthropic.com&format=full"; private static readonly HttpClient httpClient = new() { DefaultRequestHeaders = { { "Metadata-Flavor", "Google" } }, };… kubernetes Claude Developer Platform · in the page manage-claude/wif-providers/kubernetes …c-token mountPath: /var/run/secrets/anthropic.com readOnly: true ``` The token issued for this pod carries `sub: "system:serviceaccount:inference:inference-worker"` and `aud: ["ht… okta Claude Developer Platform · in the page manage-claude/wif-providers/okta …s OktaTokenProvider : IIdentityTokenProvider { private static readonly HttpClient Http = new(); public async Task<string> GetIdentityTokenAsync(CancellationToken ct = default) {… spawn.sh: called once per claimed work item Claude Developer Platform · in the page managed-agents/self-hosted-sandboxes …edit` additionally refuse paths under `read_only_roots` (typescript: `readOnlyRoots`; go: `ReadOnlyRoots`). `EnvironmentWorker` adds the session's memory store directories to these lists itself. The c… self-hosted-sandboxes-reference Claude Developer Platform · in the page managed-agents/self-hosted-sandboxes-reference …edit`, `glob`, `grep`) can reach. | | `read_only_roots` (typescript: `readOnlyRoots`; go: `ReadOnlyRoots`) | Directories under which `write` and `edit` refuse paths.… How the agent loop works Claude Code CLI · in the page agent-sdk/agent-loop …ntial execution. To enable parallel execution for a custom tool, set `readOnlyHint` in its annotations. Both the [TypeScript](/docs/en/agent-sdk/typescript.md#tool) and [Python](/docs/en/agent-sdk/pyt… Give Claude custom tools Claude Code CLI · in the page agent-sdk/custom-tools …onfigure-allowed-tools). | | Let Claude call tools in parallel | Set `readOnlyHint: true` on tools with no side effects. See [Add tool annotations](#add-tool-annotations). | | Control the error messag… Intercept and control agent behavior with hooks Claude Code CLI · in the page agent-sdk/hooks …return {} ``` ```typescript TypeScript theme={null} const autoApproveReadOnly: HookCallback = async (input, toolUseID, { signal }) => { if (input.hook_event_name !== "PreToolUse") return {}; con… Connect to external tools with MCP Claude Code CLI · in the page agent-sdk/mcp …L the agent emits, including writes, unless you restrict it. Setting `readonly = true` in the [DBHub configuration file](https://dbhub.ai/config/toml) makes DBHub reject `INSERT`, `UPDATE`, `DELETE`,… Agent SDK reference - Python Claude Code CLI · in the page agent-sdk/python …you can write each hint in camelCase or snake\_case: `ToolAnnotations(readOnlyHint=True)` and `ToolAnnotations(read_only_hint=True)` are equivalent. To read a hint back from the object, use the spelli… Agent SDK reference - TypeScript Claude Code CLI · in the page agent-sdk/typescript …le` | `string` | `undefined` | Human-readable title for the tool | | `readOnlyHint` | `boolean` | `false` | If `true`, the tool does not modify its environment | | `destructiveHint` | `boolean` | `tru… TypeScript SDK V2 session API (removed) Claude Code CLI · in the page agent-sdk/typescript-v2-preview …ession interface ```typescript theme={null} interface SDKSession { readonly sessionId: string; send(message: string | SDKUserMessage): Promise<void>; stream(): AsyncGenerator<SDKMessage, void>;… Claude Code changelog Claude Code CLI · in the page changelog …refused with the mod's reason where nobody can be asked * Added `e.isReadOnly` to a mod's `tool.check` event, set when the tool call is read-only * Added `/auto-mode-setup`: a guided setup that reads… Claude apps gateway configuration Claude Code CLI · in the page claude-apps-gateway-config …egation on the `https://www.googleapis.com/auth/admin.directory.group.readonly` scope, and `admin_email` to a Workspace administrator the service account impersonates; the Directory API requires a rea… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …-transport stdio db -- npx -y @bytebase/dbhub \ --dsn "postgresql://readonly:[email protected]:5432/analytics" ``` To confirm the server starts, run `/mcp` and check that the `db` row shows a checkm… React to events with a mod Claude Code CLI · in the page plugins/mods/events …](#approve-or-refuse-a-tool-call-before-the-user-is-asked) hook, `e.isReadOnly` is `true` when the tool reports the call as read-only. Otherwise the field is absent, not `false`. `e.isReadOnly` requir… Mods reference Claude Code CLI · in the page plugins/mods/reference …and `e.ceiling` require Claude Code v2.1.290 or later. #### The `e.isReadOnly` field on `tool.check` In a `tool.check` hook, `e.isReadOnly` is `true` when the tool reports this call as read-only. Ot… Prompt library Claude Code CLI · in the page prompt-library …eateElement('textarea'); ta.value = str; ta.setAttribute('readonly', ''); ta.style.position = 'fixed'; ta.style.opacity = '0'; document.body.appendChild(ta); ta.sel… Deploy self-hosted environments to production Claude Code CLI · in the page self-hosted-environments-deploy …environment-secret mountPath: /etc/claude readOnly: true ports: - name: health containerPort: 8080 readinessProbe:… Create custom subagents Claude Code CLI · in the page sub-agents …hooks: - type: command command: "./scripts/validate-readonly-query.sh" --- ``` Claude Code [passes hook input as JSON](/docs/en/hooks.md#pretooluse-input) via stdin to hook commands… Give Claude access to your tools Claude Documentation · in the page claude-tag/admins/add-connections …at you'll read when deciding which bundles to add to a channel: `data-readonly`, `github-write`, `monitoring`, `gtm-tools`. A capability name stays meaningful when the same bundle serves several teams… Connect Google Drive, Calendar, and Gmail Claude Documentation · in the page claude-tag/admins/connections/google …scopes to request (for example `https://www.googleapis.com/auth/drive.readonly`). If you leave the field empty, the connector requests `https://www.googleapis.com/auth/cloud-platform`. | | Subject (op… Model Context Protocol (MCP) Claude Documentation · in the page connectors/building/mcp …ool hints All MCP tools must declare both of these annotations: * [`readOnlyHint`](https://modelcontextprotocol.io/specification/latest/schema#toolannotations-readonlyhint): the tool only reads data… Connector pre-submission checklist Claude Documentation · in the page connectors/building/review-criteria …otations Every tool must include a `title` and the applicable hint: `readOnlyHint: true` for read-only tools, and `destructiveHint: true` for tools that modify or delete data. These determine auto-pe… Submit a connector to the directory Claude Documentation · in the page connectors/building/submission …proval for authentication to work * **Every tool has a `title` and a `readOnlyHint` or `destructiveHint` annotation**: the portal flags tools that are missing them, and [review criteria](/docs/connect… Changelog Claude Documentation · in the page cowork/changelog …ent ID with the device flow enabled. The new `host`, `toolsets`, and `readOnly` subfields point the connector at a GitHub Enterprise Server instance, choose which toolsets load, and offer read tools o… Configuration reference Claude Documentation · in the page third-party/claude-desktop/configuration …able. If blank, the bundled server’s default toolsets are used. > > **readOnly** `boolean` > > Offer only read tools — the server registers no write tools at all. > > **http / sse** > > Applies when `… Configuration changelog Claude Documentation · in the page third-party/claude-desktop/configuration-changelog …ent ID with the device flow enabled. The new `host`, `toolsets`, and `readOnly` subfields point the connector at a GitHub Enterprise Server instance, choose which toolsets load, and offer read tools o… Connect to GitHub Claude Documentation · in the page third-party/claude-desktop/connectors-github …-party/claude-desktop/configuration#managedmcpservers) | `toolsets`, `readOnly`, and per-tool [`toolPolicy`](/docs/third-party/claude-desktop/configuration#managedmcpservers) | | Claude Desktop versio… Tool Annotations Charter Model Context Protocol · in the page community/interest-groups/tool-annotations …g annotations**: Assess whether the current set of tool annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`, `openWorldHint`) adequately serves server and client authors * **Discussion of… SEP-1686: Tasks Model Context Protocol · in the page seps/1686-tasks …by polling a task. */ class PendingRequest<TResult> { constructor(readonly protocol: Protocol, readonly result: Promise<TResult>, readonly taskId?: string) {} /** * Waits for a result, calli… SEP-2549: TTL for List Results Model Context Protocol · in the page seps/2549-TTL-for-list-results …milliseconds after receiving the response. */ ttlMs: number & { readonly minimum: 0 }; /** * Indicates the intended scope of the cached response, analogous to HTTP * Cache-Control: publ…
Feedback