Looking for agent configuration? If you’re building AI agents that interact with MCP servers, see the Agent Configuration guide instead.
Quick Start
Server Configuration
The MCPClient uses a flexible configuration system that supports any MCP server, regardless of connection type.Configuration Structure
Server configuration is defined as a JavaScript object:Configuration Parameters
Each server entry requires a unique name and connection-specific parameters. The client automatically detects the connection type based on the provided configuration. Common Parameters:server_name: Unique identifier for the server (used as the object key)
command: Executable command to start the server (e.g.,"npx","python")args: Array of command-line argumentsenv: Environment variables for the server process
url: Full URL to the MCP server endpointheaders: Custom HTTP headers (useful for authentication)
The client automatically infers the connection type based on your configuration. Use
command for STDIO servers or url for HTTP servers. See Connection Types for detailed information.Example Configuration
Here’s a basic example of how to configure an MCP server:Multiple Server Configuration
You can configure multiple MCP servers in a single configuration file, allowing you to use different servers for different tasks or combine their capabilities (e.g.):Client Creation Methods
There are several ways to create an MCPClient:From Dictionary/Object
Create configuration programmatically:TypeScript
From Configuration File
Load configuration from a JSON file:With Sandbox Options
Enable sandboxed execution:Best Practices
- API Keys: Always use environment variables for sensitive information
- Configuration Files: Keep configuration files in version control (without sensitive data)
- Server Naming: Use descriptive names for your MCP servers
- Environment Variables: Set appropriate environment variables for each server
- Testing: Test server connections independently before using with agents
- Monitoring: Enable logging to monitor server connection health
Error Handling
Common client configuration errors and solutions:- Server Not Found: Check if the server command is installed and accessible
- Connection Timeout: Verify server is running and network connectivity
- Permission Denied: Ensure proper file permissions and environment setup
- Invalid Configuration: Validate JSON syntax and required fields