MCP Hello World

🚀 MCP 你好

mcp-hello-world 是一款用于测试和验证 MCP 协议实现的工具。它为开发者提供了简单接口，可发送请求并接收响应，以此验证 MCP 实现的正确性。

🚀 快速开始

启动 MCP 服务器：

npx mcp-hello-world

这将启动一个 MCP 服务器，监听标准输入和输出。

✨ 主要特性

资源

hello://world

• 描述：一个静态的“你好，世界”资源。
• 方法：resources/get
• 参数：无
• 返回值：{ data: '你好，世界！' }

greeting://{name}

• 描述：一个动态的问候资源。
• 方法：resources/get
• 参数：名称包含在 URI 中，例如 greeting://Bob
• 返回值：{ data: '你好，{name}！' }（例如 { data: '你好，Bob！' }）

工具

echo

• 描述：回显输入的消息，并在前面加上“你好 ”。
• 方法：tools/invoke
• 参数：{ name: 'echo', parameters: { message: string } }
• 返回值：{ content: [{ type: 'text', text: '你好 {message}' }] }（例如 { content: [{ type: 'text', text: '你好 test' }] }）

debug

• 描述：列出服务器上注册的所有 MCP 方法定义。
• 方法：tools/invoke
• 参数：{ name: 'debug', parameters: {} }
• 返回值：一个包含所有已注册资源、工具和提示的 JSON 结构。

提示

helpful-assistant

• 描述：一个基本的助手提示定义。
• 方法：prompts/get
• 参数：无
• 返回值：一个包含 system 和 user 角色的提示 JSON 结构。

📦 安装指南

你可以通过 npm 来安装 mcp-hello-world：

npm install mcp-hello-world

💻 使用示例

基础用法

创建一个客户端来连接 MCP 服务器。例如，使用 child_process 来 spawn 一个新的进程：

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

然后你可以通过这个进程的 stdio 来发送和接收 MCP 请求。

高级用法

使用标准输入输出

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

// 发送问候请求
const request = {
    jsonrpc: '2.0',
    method: 'resources/get',
    params: ['hello://world'],
    id: 1
};

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

// 监听响应
mcpServer.stdout.on('data', (data) => {
    console.log(data.toString());
});

使用 HTTP

你可以通过访问 http://localhost:3000 来发送请求。

📚 详细文档

默认情况下，服务器会监听标准输入和输出。你也可以通过环境变量来配置一些选项：

• MCP_PORT：设置监听的端口（默认为 3000）

📄 许可证

[此处应填写许可证信息，例如 MIT 许可证]

这个文档为你提供了关于如何使用和集成 mcp-hello-world 的基本指南。如果你有任何问题或建议，请随时与我们联系！

贡献者

• [你的名字] - 项目维护者