Yapi MCP Server

🚀 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 環境中調用相關函數