MCP Server Tester Po4

🚀 MCP Server Tester Documentation

The MCP Server Tester is a tool designed to test servers that support the MCP protocol. It can connect to MCP servers, discover available tools, and conduct automated tests to verify server behavior.

🚀 Quick Start

Basic Setup

1. Create a default configuration file:

   mcp-server-tester --init
   

2. Edit the mcp-servers.json file and add your own servers and configurations.
3. Create a .env file containing your Anthropic API key:

   echo "ANTHROPIC_API_KEY=your-api-key-here" > .env
   

4. Run the tests:

   mcp-server-tester
   

Testing the Development Version

Add the development server configuration to mcp-servers.json:

{
  "mcpServers": {
    "my-dev-server": {
      "command": "node",
      "args": ["/path/to/your/project/dist/server.js"],
      "env": {
        "DEBUG": "true",
        "NODE_ENV": "development"
      }
    }
  }
}

Then run the tests:

mcp-server-tester

Testing with Multiple Configuration Files

Create different configuration files for different environments:

cp mcp-servers.json config-dev.json
cp mcp-servers.json config-prod.json

Edit each file and set the corresponding configurations, then run:

mcp-server-tester ./config-dev.json
mcp-server-tester ./config-prod.json

📦 Installation

Server Configuration

Define servers in mcp-servers.json:

{
  "mcpServers": {
    "server1": {
      "command": "node",
      "args": ["index.js"],
      "env": {}
    }
  }
}

Test Settings

The test options in the configuration file include:

• numWorkers: The number of workers to execute in parallel (default: 4).
• timeoutMs: The maximum execution time for each tool (in milliseconds, default: 1000).
• outputFormat: The report format (supported: console, json, html, default: console).
• outputPath: The output file path (default: ./test-results.json or stdout).

💻 Usage Examples

Connection and Discovery

1. Connect to the server: The tester connects to the MCP server using the TCP protocol.
2. Discover tools: Obtain the list of tools supported by the server through an RPC request.

Execution and Verification

For each tool, the tester:

• Sends an RPC request.
• Waits for a response.
• Verifies if the result meets the expectations.

📚 Documentation

Console Output (Default)

Displays the test results directly in the terminal.

JSON Report

Generates a structured JSON file, with the path specified by outputPath.

HTML Report

Generates an HTML file with a visual interface for easy analysis and viewing.

🔧 Technical Details

Troubleshooting Connection Issues

• Confirm that the server configuration is correct.
• Verify that the server supports the MCP protocol.
• Increase timeoutMs for slow servers.
• Enable detailed logging: Set verbose: true.

Troubleshooting API Key Issues

• Ensure that the API key is valid and correct.
• Check if the .env file is in the project root directory.
• Verify that the key has no spaces or extra characters.

Troubleshooting Tool Execution Failures

• Confirm that the server implements the MCP protocol correctly.
• Check the server logs for error information.
• Verify that the tool parameter configuration is correct.

Project Structure

mcp-server-tester/
├── package.json          # Project dependencies and scripts
├── src/                 # Source code directory
│   ├── server.js        # Main tester program
│   └── worker.js        # Artifact for parallel execution
├── mcp-servers.json      # Server configuration file
└── .env                 # Environment variable file

Script Usage

# Install dependencies
npm install

# Run the tester
node src/server.js

# Run with different configurations
node src/server.js --config config-dev.json

Development Guide

Code Structure

• src/server.js: The main program that parses command-line arguments and initializes the tests.
• src/worker.js: Handles the execution and verification of each tool.
• src/utils/: Contains utility functions such as logging and RPC requests.

Contribution Guide

1. Ensure that all unit tests pass before submitting code.
2. Add relevant documentation for new features or bug fixes.
3. Submit a Pull Request on GitHub.

📄 License

This project is licensed under the MIT License. See the LICENSE file for detailed terms.

Welcome to use the MCP Server Tester! If you have any questions or suggestions, please feel free to contact the maintenance team.