README
🚀 MCP 服务器 - Yuque
这是一个基于 TypeScript 的 MCP 服务器,可实现简单的笔记系统,能将笔记记录到语雀。它通过资源表示、工具创建及提示生成等功能,演示了核心的 MCP 概念。
🚀 快速开始
本 MCP 服务器是基于 TypeScript 构建的,用于实现一个简单的笔记系统。它能帮助你将笔记记录到 Yuque,通过资源表示、工具操作和提示生成等功能,展示了核心的 MCP 概念。
✨ 主要特性
资源
- 可通过
note://URI 列出和访问笔记。 - 每个笔记都具备标题、内容和元数据。
- 使用简单的纯文本文档类型进行内容访问。
工具
create_note:用于创建新的文本笔记。- 需接受标题和内容作为必填参数。
- 会将笔记存储在服务器状态中。
提示
summarize_notes:可生成所有存储笔记的摘要。- 会包括所有笔记内容作为嵌入资源。
- 返回结构化的提示以供大语言模型(LLM)进行总结。
📦 安装指南
开发环境安装
安装依赖:
npm install
构建服务器:
npm run build
带有自动重建功能的开发:
npm run watch
与 Claude Desktop 配合使用的安装
要与 Claude Desktop 一起使用,请添加服务器配置:
- 在 MacOS 上:
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上:
%APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"mcp-server-yuque": {
"command": "/path/to/mcp-server-yuque/build/index.js"
}
}
}
调试
由于 MCP 服务器通过 stdio 进行通信,调试可能具有挑战性。我们推荐使用 MCP Inspector,它可以通过包分析脚本获得:
npm run inspector
Inspector 将提供一个 URL,以便在浏览器中访问调试工具。
Scan to contact