使用说明

项目简介

本项目是 'typescript-llm-integration-ls' 仓库的一部分，旨在演示如何构建一个简单的 MCP (Model Context Protocol) 服务器。该服务器定义了一个工具，可以获取指定GitHub用户的公开信息，并通过标准输入/输出 (Stdio) 与 MCP 客户端进行通信。这个示例帮助开发者理解 MCP 服务器的基本结构和工具的注册与执行流程。

主要功能点

工具注册与执行: 服务器注册了一个名为 'fetch-github-user-data' 的工具，该工具接收用户名作为参数，并调用 GitHub API 获取用户数据。
Stdio 传输: 使用 Stdio (标准输入/输出) 作为 MCP 服务器和客户端之间的通信通道。
简单的 MCP 服务器示例: 提供了一个基础的 MCP 服务器框架，展示了如何使用 '@modelcontextprotocol/sdk' 库创建和运行服务器。

安装步骤

克隆仓库: 首先克隆 'typescript-llm-integration-ls' 仓库到本地。

git clone https://github.com/mauricio-cantu/typescript-llm-integration-ls
cd typescript-llm-integration-ls

安装依赖: 在仓库根目录下，运行 'npm install' 安装项目依赖。
```
npm install
```
配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'。虽然本示例的 MCP 服务器本身可能不需要额外的 API 密钥，但为了运行仓库中的其他示例，建议您查看 '.env.example' 文件并根据需要配置 API 密钥。

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到此 MCP 服务器。

{
  "server name": "example-mcp-server",
  "command": "npx",
  "args": ["tsx", "src/11-mcp/server.ts"]
}

'server name': 服务器的名称，可以自定义，用于标识该服务器。
'command': 启动 MCP 服务器的命令。这里使用 'npx' 来运行 npm 包。
'args': 传递给 'command' 的参数数组。 'tsx src/11-mcp/server.ts' 表示使用 'tsx' (TypeScript execute) 运行 'src/11-mcp/server.ts' 文件，启动 MCP 服务器。

基本使用方法

启动 MCP 服务器: 打开一个终端窗口，导航到仓库根目录，并运行以下命令启动 MCP 服务器。
```
npx tsx src/11-mcp/server.ts
```
或者，您可以查看 'package.json' 文件中是否有预定义的脚本来运行服务器。如果没有，上述命令可以直接运行服务器代码。
运行 MCP 客户端: 打开另一个终端窗口，同样导航到仓库根目录，并运行以下命令启动 MCP 客户端。
```
npx tsx src/11-mcp/client.ts
```
与服务器类似，您也可以检查 'package.json' 中是否有客户端运行脚本。
观察输出: 客户端成功运行后，会向 MCP 服务器发送请求，调用 'fetch-github-user-data' 工具来查询 "mauricio-cantu" 用户的公开仓库数量。服务器执行工具后，会将结果返回给客户端，客户端会将结果打印到终端。

注意: 确保您已安装了 'tsx'。如果没有安装，可以使用 'npm install -g tsx' 命令进行全局安装，或者使用 'npm install tsx' 在项目本地安装。

关键词