MCP Test Client
About
MCP Test Client is a TypeScript testing utility for Model Context Protocol (MCP) servers.
Details
- Author
- crazyrabbitLTC
- GitHub stars
- 13
- Downloads
- 390
- Categories
- Developer Tools
Jump to
- Easy-to-use testing interface for MCP servers
- Built-in support for tool listing and calls
- Type-safe implementation using TypeScript
- Assertion utilities for validating responses
- Mock calculator server included for examples
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
MCP Test ClientCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Install it with bun install mcp-test-client, then import MCPTestClient, configure it with your server command and arguments, call init(), and use methods like listTools() or assertToolCall(). The package includes a mock calculator server for learning and testing.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"mcp test client": {
"mcp-test-client": {
"command": "bun",
"args": [
"test"
]
}
}
}
}McpServers
{
"mcp-test-client": {
"command": "bun",
"args": [
"test"
]
}
}MCP Test Client
A testing utility for Model Context Protocol (MCP) servers. This client helps you test MCP server implementations by providing a simple interface for making tool calls and validating responses.
Features
- Easy-to-use testing interface for MCP servers
- Built-in support for tool listing and tool calls
- Type-safe implementation using TypeScript
- Assertion utilities for validating server responses
- Mock calculator server implementation for examples
Installation
bun install mcp-test-client
Usage
Basic Example
import { MCPTestClient } from 'mcp-test-client';
describe('MCP Server Tests', () => {
let client: MCPTestClient;
beforeAll(async () => {
client = new MCPTestClient({
serverCommand: 'bun',
serverArgs: ['./path/to/your/server.ts'],
});
await client.init();
});
afterAll(async () => {
await client.cleanup();
});
test('should list available tools', async () => {
const tools = await client.listTools();
expect(tools).toContainEqual(
expect.objectContaining({
name: 'your-tool-name',
description: 'Your tool description',
})
);
});
test('should call a tool', async () => {
await client.assertToolCall(
'your-tool-name',
{ arg1: 'value1', arg2: 'value2' },
(result) => {
expect(result.content[0].text).toBe('expected result');
}
);
});
});
Calculator Server Example
The package includes a mock calculator server for testing and learning purposes:
import { MCPTestClient } from 'mcp-test-client';
describe('Calculator Server Tests', () => {
let client: MCPTestClient;
beforeAll(async () => {
client = new MCPTestClient({
serverCommand: 'bun',
serverArgs: ['./tests/mocks/calculator.ts'],
});
await client.init();
});
afterAll(async () => {
await client.cleanup();
});
test('should perform addition', async () => {
await client.assertToolCall(
'calculate',
{ operation: 'add', a: 5, b: 3 },
(result) => {
expect(result.content[0].text).toBe('8');
}
);
});
});
API Reference
MCPTestClient
Constructor
constructor(config: { serverCommand: string; serverArgs: string[] })
Methods
- init(): Promise<void> - Initialize the client and connect to the server
- listTools(): Promise<Tool[]> - Get a list of available tools from the server
- callTool(toolName: string, args: Record<string, unknown>): Promise<ToolResult> - Call a specific tool
- assertToolCall(toolName: string, args: Record<string, unknown>, assertion: (result: ToolResult) => void | Promise<void>): Promise<void> - Call a tool and run assertions on the result
- cleanup(): Promise<void> - Clean up resources and disconnect from the server
Development
Prerequisites
- Bun (v1.0.0 or higher)
Setup
1. Clone the repository
git clone <repository-url>
cd mcp-test-client
2. Install dependencies
bun install
3. Run tests
bun test
License
MIT
Contributing
1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
