Skip to content

MCP Client changes #26658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: production
Choose a base branch
from
+27 −9
Open

MCP Client changes #26658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/content/docs/agents/api-reference/agents-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ class Agent<Env, State = unknown> {
async removeMcpServer(id: string): Promise<void>;

// Get state of all connected MCP servers
getMcpServers(): MCPServersState;
async getMcpServers(): Promise<MCPServersState>;
}
```

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/agents/guides/connect-mcp-client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The `addMcpServer()` method connects to an MCP server. If the server requires OA

// List MCP state (servers, tools, etc)
if (url.pathname.endsWith("mcp-state") && request.method === "GET") {
const mcpState = this.getMcpServers();
const mcpState = await this.getMcpServers();

return new Response(JSON.stringify(mcpState, null, 2), {
headers: { "Content-Type": "application/json" },
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/agents/guides/oauth-mcp-client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ export class MyAgent extends Agent<Env, never> {
url.pathname.endsWith("connection-status") &&
request.method === "GET"
) {
const mcpState = this.getMcpServers();
const mcpState = await this.getMcpServers();

const connections = Object.entries(mcpState.servers).map(
([id, server]) => ({
Expand Down Expand Up @@ -364,7 +364,7 @@ export class ObservabilityAgent extends Agent<Env, never> {

// Endpoint: Check connection status
if (url.pathname.endsWith("status") && request.method === "GET") {
const mcpState = this.getMcpServers();
const mcpState = await this.getMcpServers();

const connections = Object.entries(mcpState.servers).map(
([id, server]) => ({
Expand Down
28 changes: 23 additions & 5 deletions src/content/docs/agents/model-context-protocol/mcp-client-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Disconnects from the MCP server, removes all related resources, and deletes the
Get the current state of all MCP server connections.

```ts
getMcpServers(): MCPServersState
async getMcpServers(): Promise<MCPServersState>
```

#### Parameters
Expand All @@ -174,7 +174,7 @@ None.

#### Returns

An `MCPServersState` object containing:
A Promise that resolves to an `MCPServersState` object containing:

```ts
{
Expand All @@ -189,7 +189,8 @@ An `MCPServersState` object containing:
| "connecting"
| "ready"
| "discovering"
| "failed";
| "failed"
| "not-connected";
capabilities: ServerCapabilities | null;
instructions: string | null;
}
Expand All @@ -210,7 +211,7 @@ export class MyAgent extends Agent<Env, never> {
const url = new URL(request.url);

if (url.pathname === "/mcp-state") {
const mcpState = this.getMcpServers();
const mcpState = await this.getMcpServers();

return new Response(JSON.stringify(mcpState, null, 2), {
headers: { "Content-Type": "application/json" },
Expand All @@ -222,7 +223,24 @@ export class MyAgent extends Agent<Env, never> {

</TypeScriptExample>

The `state` field can be: `authenticating`, `connecting`, `ready`, `discovering`, or `failed`. Use this method to monitor connection status, list available tools, or build UI for connected servers.
#### Connection States

The `state` field indicates the current connection status:

- **`authenticating`** — Waiting for OAuth authorization. The server requires OAuth and the user must complete the authorization flow via `auth_url`.
- **`connecting`** — Establishing transport connection to the MCP server. OAuth (if required) is complete, now connecting to the actual MCP endpoint.
- **`discovering`** — Discovering server capabilities. The transport is connected, now fetching available tools, resources, and prompts via the MCP protocol.
- **`ready`** — Fully connected and ready to use. Tools, resources, and prompts have been discovered and are available. This is the terminal success state.
- **`failed`** — Connection failed. Check observability events or logs for error details.
- **`not-connected`** — Server configuration is stored but no active connection exists. This occurs when a server is registered but the connection hasn't been established yet, or when the Agent has been restarted and connections are being restored.

**State transitions:**

- **Non-OAuth servers**: `connecting` → `discovering` → `ready`
- **OAuth servers**: `authenticating` → (OAuth callback) → `connecting` → `discovering` → `ready`
- Any state can transition to `failed` on error

Use this method to monitor connection status, list available tools, or build UI for connected servers.

## OAuth Configuration

Expand Down