mcp-server-demo

项目简介

本项目基于 Model Context Protocol (MCP) 协议，演示如何通过 MCP Server 向大语言模型（LLM）或客户端暴露自定义工具（Tool）和资源（Resource），并通过标准输入输出（stdio）作为通信通道进行集成。

主要功能

• 注册自定义工具（registerTool）
• 注册自定义资源（registerResource）
• 通过 StdioServerTransport 启动服务，适合本地开发和集成到 LLM 工具链

registerTool API

作用

注册一个“工具”（Tool），即带参数的接口，供 LLM 或客户端调用，实现自定义功能。

用法

server.registerTool(
  "hello", // 工具名称
  {
    title: "Hello Tool", // 工具标题
    description: "返回 hello, {name}", // 工具描述
    inputSchema: { name: z.string() }, // 输入参数校验（zod schema）
  },
  async ({ name }) => ({
    content: [{ type: "text", text: `hello, ${name}` }], // 返回内容
  })
);

返回内容格式

返回值需为对象，通常包含 content 字段，内容为数组，每项为：

• type: 内容类型（如 "text"）
• text: 文本内容

示例返回：

{
  "content": [
    { "type": "text", "text": "hello, 张三" }
  ]
}

registerResource API

作用

注册一个“资源”（Resource），即只读数据接口，供 LLM 加载到上下文，实现动态数据获取。

用法

server.registerResource(
  "hello", // 资源名称
  new ResourceTemplate("hello://{name}", { list: undefined }), // 资源模板
  {
    title: "Hello Resource", // 资源标题
    description: "动态 hello 资源", // 资源描述
  },
  async (uri, { name }) => ({
    contents: [
      {
        uri: uri.href,
        text: `hello, ${name}`,
      },
    ],
  })
);

返回内容格式

返回值需为对象，通常包含 contents 字段，内容为数组，每项为：

• uri: 资源唯一标识
• text: 文本内容

示例返回：

{
  "contents": [
    {
      "uri": "hello://张三",
      "text": "hello, 张三"
    }
  ]
}

什么是 StdioServerTransport

StdioServerTransport 是 MCP 协议中用于通信的标准输入输出（stdio）传输方式。其特点如下：

• 通过进程的标准输入（stdin）和标准输出（stdout）进行 JSON-RPC 消息的收发
• 适合本地开发、调试和集成到 LLM 工具链
• 启动后，客户端可作为子进程启动本服务，通过 stdio 通道与其通信
• 保证所有消息为 UTF-8 编码的 JSON-RPC 格式

示例代码：

const transport = new StdioServerTransport();
await server.connect(transport);

参考资料

• Model Context Protocol 官方文档
• MCP TypeScript SDK