MCP Hello World

🚀 MCP Hello

mcp-hello-world is a tool designed for testing and validating MCP protocol implementations. It offers a straightforward interface that enables developers to send requests and receive responses, thereby verifying the correctness of their MCP implementations.

🚀 Quick Start

Start the MCP server:

npx mcp-hello-world

This will initiate an MCP server that listens to standard input and output.

Basic Usage

Create a client to connect to the MCP server. For example, use child_process to spawn a new process:

const {spawn} = require('child_process');
const mcpServer = spawn('npx', ['mcp-hello-world']);

Then you can send and receive MCP requests via the stdio of this process.

📦 Installation

You can install mcp-hello-world via npm:

npm install mcp-hello-world

📚 Documentation

Configuration

By default, the server listens to standard input and output. You can also configure some options through environment variables:

• MCP_PORT: Set the listening port (default is 3000)

Provided Features

Resources

hello://world

• Description: A static "Hello, World" resource.
• Method: resources/get
• Parameters: None
• Return Value: { data: 'Hello, World!' }

greeting://{name}

• Description: A dynamic greeting resource.
• Method: resources/get
• Parameters: The name is included in the URI, e.g., greeting://Bob
• Return Value: { data: 'Hello, {name}!' } (e.g., { data: 'Hello, Bob!' })

Tools

echo

• Description: Echo the input message with "Hello " prepended.
• Method: tools/invoke
• Parameters: { name: 'echo', parameters: { message: string } }
• Return Value: { content: [{ type: 'text', text: 'Hello {message}' }] } (e.g., { content: [{ type: 'text', text: 'Hello test' }] })

debug

• Description: List all registered MCP method definitions on the server.
• Method: tools/invoke
• Parameters: { name: 'debug', parameters: {} }
• Return Value: A JSON structure containing all registered resources, tools, and prompts.

Prompts

helpful-assistant

• Description: A basic assistant prompt definition.
• Method: prompts/get
• Parameters: None
• Return Value: A JSON structure of prompts containing system and user roles.

💻 Usage Examples

Using Standard Input and Output

const {spawn} = require('child_process');
const mcpServer = spawn('npx', ['mcp-hello-world']);

// Send a greeting request
const request = {
    jsonrpc: '2.0',
    method: 'resources/get',
    params: ['hello://world'],
    id: 1
};

mcpServer.stdin.write(JSON.stringify(request) + '\n');

// Listen for responses
mcpServer.stdout.on('data', (data) => {
    console.log(data.toString());
});

Using HTTP

You can send requests by accessing http://localhost:3000.

👥 Contributors

• [Your Name] - Project Maintainer

📄 License

[License information should be filled in here, e.g., MIT License]

This document provides you with a basic guide on how to use and integrate mcp-hello-world. If you have any questions or suggestions, please feel free to contact us!