Docs: Update MCP server configuration (#396)

This commit is contained in:
N. Taylor Mullen
2025-05-16 17:19:00 -07:00
committed by GitHub
parent 7f7f2cd47e
commit c09bad9393
3 changed files with 36 additions and 10 deletions

View File

@@ -54,13 +54,22 @@ These are the main pieces of information the server `Config` object holds and us
- **Purpose:** If true, instructs relevant tools (like `read_many_files` when used implicitly by the model) to gather a broad context from the `targetDir`.
- **`toolDiscoveryCommand` (string | undefined):**
- **`toolCallCommand` (string | undefined):**
- **`mcpServerCommand` (string | undefined):**
- **Source:** `settings.json` or environment variables.
- **Purpose:** Advanced settings for customizing how tools are discovered or how the server interacts with other potential components in a more complex setup.
- `toolCallCommand` (string | undefined):
- `mcpServers` (object | undefined):
- **Source:** `settings.json` (`mcpServers` key).
- **Purpose:** Advanced setting for configuring connections to Model-Context Protocol (MCP) servers. This is an object where each key is a server name and the value is an object defining the server's parameters:
- `command` (string, required): The command to execute to start the MCP server.
- `args` (array of strings, optional): Arguments to pass to the command.
- `env` (object, optional): Environment variables to set for the server process.
- `cwd` (string, optional): The working directory in which to start the server.
- Allows discovery and use of tools from multiple MCP sources.
- `mcpServerCommand` (string | undefined, **deprecated**):
- **`userAgent` (string):**
- **Source:** `settings.json` (`mcpServerCommand` key).
- **Purpose:** Legacy setting for configuring a single MCP server. Please use `mcpServers` instead.
- `userAgent` (string):
- **Source:** Automatically generated by the CLI, often including CLI package name, version, and Node.js environment details.
- **Purpose:** Sent with API requests to help identify the client making requests to the Gemini API.