Xk6 MCP

🚀 xk6-mcp

A k6 extension for testing Model Context Protocol (MCP) servers.

🚀 Quick Start

📦 Installation

1. First, make sure you have xk6 installed:

go install go.k6.io/xk6/cmd/xk6@latest

2. Build the k6 binary with the xk6-mcp extension:

xk6 build --with github.com/dgzlopes/xk6-mcp

3. Import the mcp module at the top of your test script:

import mcp from 'k6/x/mcp';

4. The built binary will appear in the current directory. You can move it to your PATH or use it directly:

./k6 run script.js

💻 Usage Examples

Basic Usage

import mcp from 'k6/x/mcp';

// Initialize the MCP client using stdio transport
const client = new mcp.StdioClient({
  path: 'npx',
  env: [],
  args: ['-y', '@modelcontextprotocol/server-everything', '/tmp'],
});

export default function () {
  console.log('Checking MCP server status...');
  console.log('MCP server is running:', client.ping());

  // List available tools
  console.log('Available tools:');
  const tools = client.listTools().tools;
  tools.forEach(tool => console.log(`  - ${tool.name}`));

  // List available resources
  console.log('Available resources:');
  const resources = client.listResources().resources;
  resources.forEach(resource => console.log(`  - ${resource.uri}`));

  // List available prompts
  console.log('Available prompts:');
  const prompts = client.listPrompts().prompts;
  prompts.forEach(prompt => console.log(`  - ${prompt.name}`));

  // Call an example tool
  const toolResult = client.callTool({
    params: { name: 'echo', arguments: { message: 'Hello, world!' } }
  });
  console.log('Echo tool response:', toolResult.content[0].text);

  // Read an example resource
  const resourceContent = client.readResource({
    params: { uri: 'test://static/resource/1' }
  });
  console.log('Resource content:', resourceContent.contents[0].text);

  // Get an example prompt
  const prompt = client.getPrompt({
    params: { name: 'simple_prompt' }
  });
  console.log('Prompt:', prompt.messages[0].content.text);
}

Advanced Usage

You can also use the SSE transport to connect to an MCP server that supports it:

const client = new mcp.SSEClient({
  baseURL: 'http://localhost:3001/sse',
  headers: { Authorization: 'Bearer abc123' },
  timeout: '30s'
});

Run the SSE server:

docker run -p 3001:3001 --rm -it tzolov/mcp-everything-server:v1