使用说明

项目简介

LiteMCP 是一个使用 TypeScript 构建 MCP (Model Context Protocol) 服务器的轻量级框架。它可以帮助开发者快速搭建符合 MCP 协议的后端服务，为 LLM 应用提供结构化的上下文信息和功能。

主要功能点

简化 MCP 服务器开发：提供简洁的 API，用于定义和管理工具 (Tools)、资源 (Resources) 和 Prompt 模板 (Prompts)，降低 MCP 服务器的开发门槛。
全 TypeScript 支持：使用 TypeScript 开发，提供良好的类型提示和开发体验。
内置开发工具：内置 CLI 工具，方便开发者在开发模式下运行和调试服务器，并可与 MCP Inspector 集成。
灵活的传输协议：默认支持 stdio 传输协议，并可配置为 SSE (Server-Sent Events) 传输协议，满足不同场景的需求。
易于扩展和集成：框架设计简洁，易于扩展新的功能和集成到现有系统中。

安装步骤

服务器配置

MCP 客户端需要配置服务器的启动命令才能连接到 LiteMCP 服务器。以下是一个示例配置，假设你的服务器代码文件是 'server.js' (或者 'server.ts')。

{
  "serverName": "my-litemcp-server",
  "command": "npx",
  "args": ["litemcp", "dev", "server.js"]
}

'serverName': 服务器的名称，可以自定义，用于在 MCP 客户端中标识服务器。
'command': 运行服务器的命令，通常为 'npx'，用于执行本地安装的 npm 包。
'args': 传递给 'command' 的参数列表，用于指定 LiteMCP CLI 的具体操作和服务器代码文件。
- '"litemcp"': 调用 LiteMCP 命令行工具。
- '"dev"': 使用开发模式启动服务器，该模式下会使用 'mcp-cli' 客户端进行交互，方便调试。
- '"server.js"': 你的服务器代码文件路径。注意：如果你的服务器代码是 TypeScript 文件 (例如 'server.ts')，你需要先将其编译成 JavaScript 文件 (例如 'server.js')，或者使用 'tsx' 或 'ts-node' 等工具直接运行 TypeScript 文件。如果直接运行 'server.ts' 文件，'args' 配置可能需要调整为 '["npx", "tsx", "server.ts"]' 或 '["npx", "ts-node", "server.ts"]'，具体取决于你的环境配置。

基本使用方法

创建服务器代码文件：在你项目的根目录下创建一个 JavaScript 或 TypeScript 文件，例如 'server.js' 或 'server.ts'。
编写服务器代码：复制粘贴仓库提供的 'example.ts' 或 'example.js' 示例代码到你的服务器代码文件中，并根据需要修改工具、资源和 Prompt 的定义。
启动服务器：打开终端，导航到你的项目目录，并运行以下命令启动服务器（开发模式）：
```
npx litemcp dev server.js
```
或者，你可以使用 'inspect' 命令配合 MCP Inspector 进行调试：
```
npx litemcp inspect server.js
```
连接 MCP 客户端：配置你的 MCP 客户端，使其连接到 LiteMCP 服务器。客户端需要配置服务器的名称、启动命令等信息，并使用 JSON-RPC 协议与服务器通信。

关键词