yapi-mcp-service MCP Server

yapi-mcp-service MCP Server

site icon
2025.03.12 1
JavaScript笔记管理文本摘要其它
yapi-mcp-service 是一个基于 TypeScript 的 MCP 服务器,实现了一个简单的笔记系统。它通过提供资源、工具和提示来展示核心 MCP 概念。该服务器允许用户创建、访问和总结文本笔记,适用于需要简单笔记管理和总结功能的场景。
View on GitHub

Overview

基本能力

产品定位

yapi-mcp-service 是一个基于 Model Context Protocol (MCP) 的服务器,主要用于实现和管理文本笔记系统。

核心功能

  1. 资源管理
  2. 通过 note:// URI 列出和访问笔记
  3. 每个笔记包含标题、内容和元数据
  4. 使用纯文本 MIME 类型简化内容访问

  5. 工具功能

  6. create_note:创建新的文本笔记

    • 需要标题和内容作为必需参数
    • 将笔记存储在服务器状态中
  7. 提示功能

  8. summarize_notes:生成所有存储笔记的摘要
    • 包含所有笔记内容作为嵌入式资源
    • 返回结构化提示用于 LLM 摘要

适用场景

  • 个人笔记管理
  • 文本内容摘要生成
  • MCP 协议学习和开发

工具列表

  1. create_note:创建新的文本笔记
  2. summarize_notes:生成所有存储笔记的摘要

常见问题解答

  • 调试 MCP 服务器可能具有挑战性,因为通信是通过 stdio 进行的。建议使用 MCP Inspector 进行调试。

使用教程

使用依赖

安装 Node.js 和 npm。

安装教程

  1. 安装依赖:
npm install
  1. 构建服务器:
npm run build
  1. 开发时自动重建:
npm run watch
  1. 与 Claude Desktop 一起使用,添加服务器配置:
  2. MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  3. Windows: %APPDATA%/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "yapi-mcp-service": {
      "command": "/path/to/yapi-mcp-service/build/index.js"
    }
  }
}

调试方式

使用 MCP Inspector 进行调试:

npm run inspector

Inspector 将提供一个 URL,用于在浏览器中访问调试工具。

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。