Simple MCP

一个简单的 TypeScript 库，用于创建 MCP (模型上下文协议) 服务器。

特性

• 简单 API: 使用最少的代码创建 MCP 服务器
• 类型安全: 完整的 TypeScript 集成
• 参数验证: 内置 Zod 验证
• MCP 兼容: 完全实现了模型上下文协议

安装

npm install simple-mcp

快速开始

import { McpServer } from 'simple-mcp';
import { z } from 'zod';

// 创建一个服务器实例
const server = new McpServer({ name: 'my-server' });

// 向服务器注册工具
server.tool({
  name: 'greet',
  parameters: {
    name: z.string().describe('Person\'s name')
  },
  execute: async ({ name }) => {
    return {
      content: [
        {
          type: 'text',
          text: `Hello, ${name}! Nice to meet you.`
        }
      ]
    };
  }
});

// 启动服务器
server.start({ transportType: 'stdio' });

基于类的实现

您还可以使用类来实现 MCP 工具：

import { McpServer, type McpTool } from 'simple-mcp';
import { z, ZodObject } from 'zod';

const parameters = {
  name: z.string().describe('The name is required'),
};

class GreetTool implements McpTool<typeof parameters> {
  public readonly name = 'greet';
  public readonly parameters = parameters;

  public async execute({ name }: z.infer<ZodObject<typeof this.parameters>>) {
    return {
      content: [
        {
          type: 'text',
          text: `Hello, ${name}! Nice to meet you.`,
        },
      ],
    };
  }
}

// 使用名称 'greet-server' 初始化一个新的 MCP 服务器
const server = new McpServer({ name: 'greet-server' });

// 创建 GreetTool 类的一个实例
const greetTool = new GreetTool();

// 向服务器注册工具
server.tool(greetTool);

// 使用 stdio 作为传输方法启动服务器
server.start({ transportType: 'stdio' });

示例

查看 examples 目录 获取更完整的示例：

• Greeting Tool - 简单的问候示例
• Calculator Tool - 数学运算示例

贡献

欢迎贡献！ 随时提出问题或提交拉取请求。

许可证

MIT