Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions dotnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ await session.SendAsync(new MessageOptions { Prompt = "What is 2+2?" });
await done.Task;
```

When targeting MCP tools configured through `McpServers`, remember the runtime
tool name is `<server-key>-<tool-name>`. For `AvailableTools` and
`ExcludedTools`, prefer the source-qualified form
`mcp:<server-key>-<tool-name>`. For `CustomAgents[].Tools` and
`DefaultAgent.ExcludedTools`, use `<server-key>-<tool-name>` directly.

## API Reference

### CopilotClient
Expand Down
6 changes: 6 additions & 0 deletions go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ func main() {
}
```

When targeting MCP tools configured through `MCPServers`, remember the runtime
tool name is `<server-key>-<tool-name>`. For `AvailableTools` and
`ExcludedTools`, prefer the source-qualified form
`mcp:<server-key>-<tool-name>`. For `CustomAgents[].Tools` and
`DefaultAgent.ExcludedTools`, use `<server-key>-<tool-name>` directly.

## Distributing your application with an embedded GitHub Copilot CLI

The SDK supports bundling, using Go's `embed` package, the Copilot CLI binary within your application's distribution.
Expand Down
7 changes: 7 additions & 0 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,13 @@ public class CopilotSDK {
}
```

When targeting MCP tools configured through `setMcpServers(...)`, remember the
runtime tool name is `<server-key>-<tool-name>`. For `setAvailableTools(...)`
and `setExcludedTools(...)`, prefer the source-qualified filter form
`mcp:<server-key>-<tool-name>`. For `CustomAgentConfig.setTools(...)` and
`DefaultAgentConfig.setExcludedTools(...)`, use `<server-key>-<tool-name>`
directly.

## Try it with JBang

You can run the SDK without setting up a full Java project, by using [JBang](https://www.jbang.dev/).
Expand Down
6 changes: 6 additions & 0 deletions nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ await using session = await client.createSession({
// session is automatically disconnected when leaving scope
```

When targeting MCP tools configured through `mcpServers`, remember the runtime
tool name is `<server-key>-<tool-name>`. For `availableTools` and
`excludedTools`, prefer `new ToolSet().addMcp("<server-key>-<tool-name>")` or
the raw `mcp:<server-key>-<tool-name>` form. For `customAgents[].tools` and
`defaultAgent.excludedTools`, use `<server-key>-<tool-name>` directly.

## API Reference

### CopilotClient
Expand Down
1 change: 1 addition & 0 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ These are passed as keyword arguments to `create_session()`:
- `on_permission_request` (callable): Optional handler called before each tool execution to approve or deny it. When omitted, permission requests are emitted as events and left pending for manual resolution. Use `PermissionHandler.approve_all` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section.
- `on_user_input_request` (callable): Handler for user input requests from the agent (enables ask_user tool). See [User Input Requests](#user-input-requests) section.
- `hooks` (SessionHooks): Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section.
- `available_tools` / `excluded_tools` / `default_agent.excluded_tools` / custom-agent `tools`: MCP tools registered from `mcp_servers` are exposed to the runtime as `<server-key>-<tool-name>`. For `available_tools` and `excluded_tools`, prefer `ToolSet().add_mcp("<server-key>-<tool-name>")` or the raw `mcp:<server-key>-<tool-name>` form. For custom-agent `tools` and `default_agent.excluded_tools`, use `<server-key>-<tool-name>` directly.

**Session Lifecycle Methods:**

Expand Down
6 changes: 6 additions & 0 deletions rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ client.stop().await.ok();
# }
```

When targeting MCP tools configured through `mcp_servers`, remember the runtime
tool name is `<server-key>-<tool-name>`. For `available_tools` and
`excluded_tools`, prefer `ToolSet::new().add_mcp("<server-key>-<tool-name>")`
or the raw `mcp:<server-key>-<tool-name>` form. For `custom_agents[].tools`
and `default_agent.excluded_tools`, use `<server-key>-<tool-name>` directly.

## Architecture

```text
Expand Down
Loading