🚀 yapi - MCP 服务器
yapi - MCP 服务器是一个基于 TypeScript 的 MCP 服务器，实现了一个简单的笔记系统。它通过资源、工具和提示这几个核心 MCP 概念，展示了笔记的创建、访问和摘要生成等功能。
🚀 快速开始
要使用 yapi - MCP 服务器，你需要先进行开发环境的搭建和服务器的安装配置。
开发环境搭建
安装依赖：
npm install
构建服务器：
npm run build
带有自动重建功能的开发：
npm run watch
安装配置
要与 Claude Desktop 一起使用，添加服务器配置：
- 在 MacOS 上：
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上：
%APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"yapi-mcp-service": {
"command": "/path/to/yapi-mcp-service/build/index.js"
}
}
}
调试
由于 MCP 服务器通过 stdio 进行通信，调试可能具有挑战性。我们推荐使用 MCP Inspector，它作为包脚本可用：
npm run inspector
Inspector 将提供一个访问浏览器中的调试工具的 URL。
✨ 主要特性
资源
- 可列出和访问使用
note://URI 的笔记。 - 每个笔记包含标题、内容和元数据。
- 使用纯文本 MIME 类型进行简单的内容访问。
工具
create_note- 创建新的文本笔记：- 需要传递标题和内容参数。
- 在服务器状态中存储笔记。
提示
summarize_notes- 生成所有存储笔记的摘要：- 包括所有笔记内容作为嵌入资源。
- 返回结构化的提示以供 LLM 进行摘要。
📦 安装指南
要与 Claude Desktop 一起使用，需在不同操作系统的指定配置文件中添加服务器配置：
- 在 MacOS 上：
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上：
%APPDATA%/Claude/claude_desktop_config.json
配置内容如下：
{
"mcpServers": {
"yapi-mcp-service": {
"command": "/path/to/yapi-mcp-service/build/index.js"
}
}
}
💻 使用示例
基础用法
以下是使用 create_note 工具创建新笔记的示例：
# 假设你已经完成了开发环境的搭建和服务器的构建
# 这里只是示意，实际调用可能需要根据具体情况调整
# 例如在 Node.js 环境中调用相关函数
高级用法
使用 summarize_notes 工具生成所有存储笔记的摘要：
# 同样，这里只是示意，实际调用可能需要根据具体情况调整
# 例如在 Node.js 环境中调用相关函数