article
README
🚀 GitHub 服务器 MCP 服务端
这是一个基于 TypeScript 的 MCP 服务器,实现了简单的笔记系统。它借助资源、工具和提示等功能,生动演示了核心的 MCP 概念,能让用户便捷地管理和查看笔记。
🚀 快速开始
本 MCP 服务器可实现简单笔记系统的各项功能。使用前,需完成依赖安装、服务器构建等操作,具体步骤如下文所示。
✨ 主要特性
资源
- 可通过
note://URI 列出和访问笔记。 - 每个笔记包含标题、内容和元数据。
- 采用简单的纯文本 MIME 类型进行内容访问。
工具
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": {
"github-server": {
"command": "/path/to/github-server/build/index.js"
}
}
}
调试
由于 MCP 服务器通过 stdio 进行通信,调试可能会有挑战。我们推荐使用 MCP Inspector,它作为包脚本可用:
npm run inspector
Inspector 将提供一个访问浏览器中的调试工具的 URL。
扫码联系在线客服