sol MCP server typescript

Todo MCP服务器：赋予人工智能任务管理能力。（示例演示）

此示例项目演示了如何构建用于管理待办事项列表的模型上下文协议（MCP）服务器。通过利用MCP标准，该服务器使AI代理和其他兼容应用程序能够通过结构化和可发现的界面与待办事项列表功能进行交互和控制。

什么是MCP服务器？

MCP服务器的核心是充当智能代理（如AI模型）和特定功能或数据之间的桥梁。它将这些功能暴露为人工智能可以理解和使用的“工具”。可以把它看作是给人工智能一个组织良好的工具箱，每个工具都有明确的目的和明确的使用方式。

使用MCP服务器的主要好处包括：

• 结构化交互：MCP为人工智能提供了一种标准化的方式来理解如何调用函数（工具）、它们需要什么参数以及期望什么样的响应。
• 工具发现：人工智能可以查询MCP服务器，以发现可用的工具以及如何使用它们，使集成更加动态，减少对硬编码知识的依赖。
• 可扩展性：您可以轻松地向MCP服务器添加新功能（新工具），使AI无需重新培训核心逻辑即可获得新功能。
• 抽象：MCP服务器抽象掉了底层的实现细节（如数据库交互或API调用），为AI提供了一个干净一致的接口。

使用FastMCP TypeScript库构建

此Todo MCP服务器是使用 FastMCP TypeScript库。FastMCP简化了在Node.js和TypeScript中创建符合MCP的服务器的过程。它为定义工具、处理参数和管理与MCP客户端的通信提供了一个强大的框架。

作为MCP工具与Todo API集成

这个解决方案采用了一种有趣的方法：它不是直接管理MCP服务器本身的待办事项列表，而是通过调用现有的RESTful Todo API来充当中介。这意味着MCP服务器公开了一些工具，这些工具在后台与您专用的Todo API交互，以执行创建、搜索、更新和删除Todo等操作。

以下是对其工作原理和方式的详细分析：

• 利用现有的基础设施：如果您已经有了一个完善的Todo API，它有自己的数据存储（如PostgreSQL数据库）和业务逻辑，那么MCP服务器可以在此基础上构建，而不是复制它。
• AI的抽象：与MCP服务器交互的AI不需要知道REST API的复杂性（例如，特定端点、HTTP方法、请求主体）。MCP服务器提供了一个更简单、基于工具的界面。
• 专注于编排：MCP服务器的角色是编排AI请求和后端API之间的交互。它将人工智能的工具调用转换为必要的API请求，并为人工智能格式化API响应。

本质上，MCP服务器定义了add_todos、search_todos，update_todos和remove_todos等工具。当AI代理使用所需参数调用其中一个工具时，MCP服务器将：

接收工具调用及其参数。

• 根据调用的工具和提供的参数，向Todo API构造适当的HTTP请求。
• 将请求发送到您的Todo API。
• 接收Todo API的响应。
• 按照MCP标准和工具的返回模式的定义，将API响应格式化为AI可以理解的结构化结果。
• 将结果返回给AI代理。

此设计允许您通过MCP协议以标准化且易于使用的方式向AI代理公开现有Todo API的功能。

设置PostgreSQL数据库

在运行Todo API和MCP服务器之前，您需要确保您的PostgreSQL数据库已经设置好并创建了必要的表。在Todo_Db_Library项目解决方案中执行以下步骤：

• 导航到终端中的Todo_Db_Library项目目录。

• 生成数据库迁移（如果需要）：如果您对数据库实体（模型）进行了更改，则需要生成一个迁移文件来反映这些更改。运行以下命令：

npm run typeorm:generate

此命令通常会在项目的迁移目录中创建一个新的迁移文件。检查生成的文件，以确保它准确反映您预期的数据库架构更改。

应用数据库迁移：一旦迁移文件（或者如果您有现有的迁移）准备就绪，使用以下命令将它们应用于PostgreSQL数据库：

npm run typeorm:migrate

此命令将执行任何挂起的迁移文件，根据您定义的实体创建或更新todo数据库中的表。

运行Todo REST API

随着数据库的建立，您现在可以启动Todo REST API了。这个API将是MCP服务器与之通信的后端。在Todo_API项目解决方案中执行以下步骤：

• 导航到终端中的Todo_API项目目录。
• 运行开发服务器：使用以下命令启动API开发服务器：

npm run dev

该命令通常会启动API服务器，并启用热重新加载等功能进行开发。保持此服务器在后台运行。

• 确保Redis Docker正在运行：这个Todo API依赖Redis进行缓存。确保你有一个Redis Docker容器正在运行。如果你没有设置它，你需要安装Docker，然后运行一个Redis容器。运行Redis容器的基本命令是：

docker run -d -p 6379:6379 redis

• .env配置：在运行API之前，请确保Todo_API项目根目录中有一个.env文件，该文件具有以下配置。根据需要调整值以匹配您的本地环境，特别是数据库和Redis连接详细信息。

# PORT
PORT = 3000

# LOG
LOG_FORMAT = dev
LOG_DIR = ../logs

# Database
DB_HOST = localhost
#Local Docker
#DB_HOST=host.docker.internal
DB_PORT = 5432
DB_USERNAME = postgres
DB_PASSWORD = root
DB_DATABASE = todo

# Redis
REDIS_HOST = 127.0.0.1
#Local Docker
#DB_HOST=host.docker.internal
#REDIS_USERNAME = username
#REDIS_PASSWORD = password
REDIS_DB = 0
REDIS_PORT = 6379

#AES
ENCRYPTION_KEY=RWw5ejc0Wzjq0i0T2ZTZhcYu44fQI5M7

#Rate Limit Size
RATE_LIMITER=100

运行Todo MCP服务器

随着数据库的建立和Todo API的运行，您现在可以启动MCP服务器了。该服务器将公开人工智能代理可以用来与Todo API交互的工具。在MCP_server项目解决方案中执行以下步骤：

• 导航到终端中的MCP_server项目目录。
• 运行MCP检查器：对于这个项目，您已经指示使用npm Run MCP检查器。此命令可能会启动FastMCP检查器，这是一个帮助您可视化和测试MCP服务器功能的工具。运行命令：

npm run mcp-inspector

FastMCP检查器通常会启动一个web界面（通常可以在浏览器中访问），您可以在其中看到定义的工具、它们的参数，甚至模拟对它们的调用。这是开发和测试的宝贵工具。

• .env配置：在运行MCP服务器之前，请确保MCP_server项目根目录中有一个.env文件，其配置如下：

MCP_SERVER_NAME=todo_mcp_server
BASE_URL=http://localhost:3000
#AES
ENCRYPTION_KEY=RWw5ejc0Wzjq0i0T2ZTZhcYu44fQI5M7

配置Claude Desktop以连接到Todo MCP服务器（示例）

要使Claude Desktop（或其他兼容MCP的客户端）能够与您的Todo MCP服务器交互，您需要将其配置为识别并连接到您的服务器。配置格式可能因客户端应用程序而异。对于Claude Desktop，您通常会修改其配置文件（例如Claude_Desktop_config.json）。 https://github.com/punkpeye/fastmcp?tab=readme-ov文件#如何与claude桌面一起使用

以下是一个示例配置片段，您可以将其添加到Claude Desktop的配置中，以连接到本地运行的Todo MCP服务器：

{
  "mcpServers": {
    "Todo MCP Server": {
      "command": "npx",
      "args": [
        "start"
      ],
      "cwd": "YOUR_MCP_SOLUTION_PATH"
    }
  }
}

此配置的说明：

• “Todo MCP服务器”：这是一个用户友好的名称，将在Claude Desktop中标识您的MCP服务器。
• “command”：“npx”：指定要执行的命令以启动MCP服务器。它假设您在MCP_server项目的package.json中定义了一个运行MCP服务器的“start”脚本（例如，“start”：“node-dist/index.js”或类似脚本）。
• “args”：\[“start”\]：这为npx命令提供参数，在本例中是要运行的npm脚本的名称。
• “cwd”：“C:\\MCP_Server”：这将在执行命令之前将当前工作目录设置为MCP_Server项目目录。这很重要，这样npx就可以找到package.json文件并正确运行指定的脚本。记得用系统上MCP_server项目的实际路径替换此路径。

下一步：

一旦MCP服务器运行（并且可以访问检查器），您可以：

• 探索已定义的工具：使用检查器的界面查看add_todos、search_todos，update_todos和remove_todos工具，以及它们的参数和描述。
• 模拟工具调用：使用检查器向MCP服务器发送具有不同参数的测试请求，并观察响应。这允许您验证MCP服务器是否正确地与Todo API交互并格式化结果。
• 与AI代理集成：最终目标是将此MCP服务器连接到理解MCP协议的AI代理。然后，人工智能可以发现可用的工具，并根据用户请求或自己的推理使用它们来管理待办事项列表。
• 此设置提供了一种强大的模块化方式来管理您的待办事项列表，并通过模型上下文协议和FastMCP库的强大功能将其功能暴露给智能代理。请记住查阅FastMCP文档，了解更多高级功能和配置选项。