fix(api): preserve read-only metadata

Author: Tom-Ryder

Examples/AgentCode/Sources/AgentCode/CodingTools.swift

@@ -21,7 +21,8 @@ enum CodingTools {
         try Tool<EmptyParameters, WorkspaceStatus, CodingContext>(
             name: "workspace_status",
             description: "Inspect the current workspace root, detected package type, and git status.",
-            isConcurrencySafe: true
+            isConcurrencySafe: true,
+            isReadOnly: true
         ) { _, context in
             let gitStatus = try await context.commandRunner.run(
                 CommandInvocation(command: "git", arguments: ["status", "--short", "--branch"], timeoutSeconds: 10),
@@ -39,7 +40,8 @@ enum CodingTools {
         try Tool<ListFilesParameters, FileList, CodingContext>(
             name: "list_files",
             description: "List text-oriented source files in the workspace.",
-            isConcurrencySafe: true
+            isConcurrencySafe: true,
+            isReadOnly: true
         ) { params, context in
             let limit = try ToolLimits.bounded(params.limit, default: 250, maximum: 500)
             let files = try context.workspace.listFiles(limit: limit + 1)
@@ -51,7 +53,8 @@ enum CodingTools {
         try Tool<ReadFileParameters, FileContent, CodingContext>(
             name: "read_file",
             description: "Read one UTF-8 text file inside the workspace.",
-            isConcurrencySafe: true
+            isConcurrencySafe: true,
+            isReadOnly: true
         ) { params, context in
             try FileContent(path: params.path, content: context.workspace.readFile(params.path))
         }
@@ -61,7 +64,8 @@ enum CodingTools {
         try Tool<GrepParameters, SearchResults, CodingContext>(
             name: "grep",
             description: "Search workspace text files by literal text or regular expression.",
-            isConcurrencySafe: true
+            isConcurrencySafe: true,
+            isReadOnly: true
         ) { params, context in
             try SearchEngine().search(
                 query: params.query,
@@ -76,7 +80,8 @@ enum CodingTools {
         try Tool<GlobParameters, FileList, CodingContext>(
             name: "glob",
             description: "Find workspace files matching a glob pattern such as Sources/**/*.swift.",
-            isConcurrencySafe: true
+            isConcurrencySafe: true,
+            isReadOnly: true
         ) { params, context in
             let limit = try ToolLimits.bounded(params.limit, default: 100, maximum: 500)
             let files = try context.workspace.glob(params.pattern, limit: limit + 1)
@@ -88,7 +93,8 @@ enum CodingTools {
         try Tool<EmptyParameters, String, CodingContext>(
             name: "git_diff",
             description: "Return the current git diff for the workspace.",
-            isConcurrencySafe: true
+            isConcurrencySafe: true,
+            isReadOnly: true
         ) { _, context in
             try await context.workspace.currentDiff()
         }

Sources/AgentRunKit/Documentation.docc/Articles/DefiningTools.md

@@ -125,7 +125,7 @@ let searchTool = try Tool<SearchParams, String, EmptyContext>(
 | Property | Default | Description |
 |---|---|---|
 | `isConcurrencySafe` | `false` | Whether the tool can safely run concurrently with other tools. ``Agent`` honors this: unsafe tools form exclusive barriers in the execution schedule. |
-| `isReadOnly` | `false` | Whether the tool only reads state without side effects. This is advisory metadata for callers and approval policy. |
+| `isReadOnly` | `false` | Whether the tool only reads state without side effects. This is advisory metadata for callers. |
 | `maxResultCharacters` | `nil` | Per-tool override for ``AgentConfiguration/maxToolResultCharacters``. When set, this limit governs instead of the global default. |
 | `strict` | `nil` | Whether the provider should enforce strict JSON Schema adherence on the tool's arguments. Preserved on first-party OpenAI Chat and Responses function tools where supported; unsupported providers reject strict schemas instead of dropping the request. |
 

Sources/AgentRunKit/Documentation.docc/Articles/SubAgents.md

@@ -96,7 +96,7 @@ When a sub-agent executes, ``SubAgentTool`` calls `descending()` to increment th
 
 **Tool timeout.** `toolTimeout` overrides the parent agent's default tool timeout for this sub-agent invocation. `nil` (the default) inherits the parent's ``AgentConfiguration/toolTimeout``.
 
-**Tool metadata.** `SubAgentTool` also exposes `isConcurrencySafe`, `isReadOnly`, and `maxResultCharacters`, matching `Tool`. ``Agent`` honors `isConcurrencySafe` for scheduling: sibling sub-agents default to sequential execution and must opt in to concurrent execution. `isReadOnly` is advisory metadata for callers and approval policy.
+**Tool metadata.** `SubAgentTool` also exposes `isConcurrencySafe`, `isReadOnly`, and `maxResultCharacters`, matching `Tool`. ``Agent`` honors `isConcurrencySafe` for scheduling: sibling sub-agents default to sequential execution and must opt in to concurrent execution. `isReadOnly` is advisory metadata for callers.
 
 ## Streaming Propagation