mcp-server

mcp-server

site icon
2025.01.14 3
TypeScriptMCP 服务器AI 开发工具开发效率
mcp-server 是一个实现了 Model Context Protocol (MCP) 的简单服务器,旨在为 AI 开发者提供一个更简单的 API 来与 MCP 交互。它通过提供一个 facade 模式来简化创建 MCP 服务器的过程,开发者只需创建自定义逻辑的工具并注册到服务器即可。
View on GitHub

Overview

基本能力

产品定位

mcp-server 是一个为 AI 开发者设计的工具,旨在简化与 Model Context Protocol (MCP) 的交互过程,提供更高效的开发体验。

核心功能

  • 实现 Model Context Protocol (MCP),提供简化的 API。
  • 支持自定义工具的开发与注册。
  • 提供工具基类(Tool),开发者可以继承并实现自己的逻辑。
  • 支持工具输入参数的 schema 定义。

适用场景

  • AI 开发者需要快速实现 MCP 服务器。
  • 需要简化 MCP 交互流程的项目。
  • 开发者希望快速集成自定义工具到 MCP 生态中。

工具列表

  • EchoTool: 一个简单的回显工具,用于演示如何实现自定义工具。

常见问题解答

  • 如何注册工具? 使用 myServer.registerTool("工具名称", 工具类) 方法注册。
  • 如何启动服务器? 调用 myServer.run() 方法启动服务器。
  • 如何测试服务器? 可以使用支持 MCP 的客户端(如 Claude Desktop)进行测试。

使用教程

使用依赖

安装前置依赖的命令如下:

yarn init -y
yarn add @modelcontextprotocol/sdk zod zod-to-json-schema
yarn add -D @types/node typescript
yarn add @la-rebelion/mcp-server

安装教程

  1. 创建项目目录并初始化:
mkdir -p my-server/src
cd my-server/
yarn init -y
  1. 安装依赖(见上)。
  2. 创建 tsconfig.json 文件并配置 TypeScript。
  3. 实现自定义工具(如 EchoTool)并注册到服务器。
  4. 创建 index.ts 文件并启动服务器。

调试方式

  1. 构建项目:
yarn build
  1. 启动服务器:
yarn start
# 或
node build/index.js
  1. 使用支持 MCP 的客户端进行测试。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。