Skip to content

Commit 8f3125e

Browse files
committed
docs
1 parent 543ae60 commit 8f3125e

1 file changed

Lines changed: 85 additions & 9 deletions

File tree

docs/protocol.md

Lines changed: 85 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1941,47 +1941,123 @@ interface MCPServerUpdatedParams {
19411941
name: string;
19421942

19431943
/**
1944-
* The command to start this server.
1944+
* The command used to start this server (stdio transport).
19451945
*/
1946-
command: string;
1946+
command?: string;
19471947

19481948
/**
1949-
* The arguments to start this server.
1949+
* The arguments passed to the command (stdio transport).
19501950
*/
1951-
args: string[];
1951+
args?: string[];
1952+
1953+
/**
1954+
* The URL of the server (Streamable HTTP transport).
1955+
*/
1956+
url?: string;
19521957

19531958
/**
19541959
* The status of the server.
19551960
*/
19561961
status: 'running' | 'starting' | 'stopped' | 'failed' | 'disabled' | 'requires-auth';
1962+
1963+
/**
1964+
* Whether the server has an OAuth access token.
1965+
*/
1966+
hasAuth: boolean;
19571967

19581968
/**
1959-
* The tools supported by this mcp server if not disabled.
1969+
* The tools provided by this MCP server.
19601970
*/
19611971
tools?: ServerTool[];
1972+
1973+
/**
1974+
* The prompts provided by this MCP server.
1975+
*/
1976+
prompts?: ServerPrompt[];
1977+
1978+
/**
1979+
* The resources provided by this MCP server.
1980+
*/
1981+
resources?: ServerResource[];
19621982
}
19631983

19641984
interface ServerTool {
19651985
/**
1966-
* The server tool name.
1986+
* The tool name.
19671987
*/
19681988
name: string;
19691989

19701990
/**
1971-
* The server tool description.
1991+
* The tool description.
19721992
*/
19731993
description: string;
19741994

19751995
/**
1976-
* The server tool parameters.
1996+
* The tool parameters (JSON Schema).
19771997
*/
19781998
parameters: any;
19791999

19802000
/**
1981-
* Whether this tool is disabled.
2001+
* Whether this tool is disabled by the current agent configuration.
19822002
*/
19832003
disabled?: boolean;
19842004
}
2005+
2006+
interface ServerPrompt {
2007+
/**
2008+
* The prompt name.
2009+
*/
2010+
name: string;
2011+
2012+
/**
2013+
* The prompt description.
2014+
*/
2015+
description: string;
2016+
2017+
/**
2018+
* The prompt arguments.
2019+
*/
2020+
arguments?: PromptArgument[];
2021+
}
2022+
2023+
interface PromptArgument {
2024+
/**
2025+
* The argument name.
2026+
*/
2027+
name: string;
2028+
2029+
/**
2030+
* The argument description.
2031+
*/
2032+
description: string;
2033+
2034+
/**
2035+
* Whether this argument is required.
2036+
*/
2037+
required: boolean;
2038+
}
2039+
2040+
interface ServerResource {
2041+
/**
2042+
* The resource URI.
2043+
*/
2044+
uri: string;
2045+
2046+
/**
2047+
* The resource name.
2048+
*/
2049+
name: string;
2050+
2051+
/**
2052+
* The resource description.
2053+
*/
2054+
description: string;
2055+
2056+
/**
2057+
* The MIME type of the resource.
2058+
*/
2059+
mimeType: string;
2060+
}
19852061
```
19862062

19872063
### Stop MCP server (➡️)

0 commit comments

Comments
 (0)