使用说明
项目简介
本项目是一个使用 Model Context Protocol (MCP) 构建的轻量级笔记系统,旨在演示 MCP 的核心概念。它允许 AI 助手通过 MCP 协议与服务器交互,实现笔记的创建、读取、总结等功能。此 Demo 服务基于 FastMCP 框架开发,易于与 Claude Desktop 或 Cursor 等 MCP 客户端集成。
主要功能点
- 添加新笔记:允许 AI 助手向服务器添加新的笔记内容。
- 读取所有笔记:允许 AI 助手获取服务器中存储的所有笔记。
- 获取最新笔记:允许 AI 助手快速访问最近添加的笔记。
- AI 摘要生成:支持 AI 助手请求服务器对现有笔记进行总结。
安装步骤
- 克隆仓库
git clone https://github.com/pi-prakhar/mcp-server-demo.git cd mcp-server-demo - 安装依赖
本项目使用 'uv' 包管理器管理依赖。请确保已安装 'uv',然后执行以下命令安装项目依赖:
uv pip install -e . - 运行服务器
使用以下命令启动 MCP 服务器进行开发和测试:
uv run mcp dev main.py
服务器配置
要将此 MCP 服务器连接到 MCP 客户端(如 Claude Desktop 或 Cursor),您需要在客户端中配置服务器信息。以下是配置示例,您需要根据您的实际环境进行调整。
Claude Desktop 配置示例
在 Claude Desktop 的配置文件 ('claude_desktop_config.json') 中,添加以下 'mcpServers' 配置:
{ "mcpServers": { "AI Sticky Notes": { // 服务器名称,您可以自定义 "command": "uv", // 启动服务器的命令,这里使用 uv "args": [ // 启动命令的参数 "run", "--with", "mcp[cli]", "mcp", "run", "/path/to/mcp-server-demo/main.py" // main.py 脚本的完整路径,请替换为您的实际路径 ] } } }
Cursor IDE 配置示例
在 Cursor IDE 中,您可以通过以下步骤添加 MCP 服务器配置:
- 打开 Cursor 设置 (Cursor Settings) -> Features -> MCP。
- 点击 "+ Add New MCP Server" 按钮。
- 填写表单:
- Type: 选择 'stdio' 作为传输方式。
- Name: 输入 'ai-sticky-notes' 或其他您自定义的名称。
- Command: 输入以下命令,并替换 '/path/to/mcp-server-demo/main.py' 为 'main.py' 脚本的完整路径:
uv run --with mcp[cli] mcp run /path/to/mcp-server-demo/main.py
- 点击 "Add" 完成添加。
注意:
- 请务必将配置中的 '/path/to/mcp-server-demo/main.py' 替换为 'main.py' 脚本在您本地文件系统中的完整路径。
- 如果 MCP 客户端报告找不到 'uv' 命令,您可能需要提供 'uv' 可执行文件的完整路径,或者确保 'uv' 所在的目录已添加到系统的 PATH 环境变量中。
基本使用方法
成功配置并连接 MCP 服务器后,您可以在 MCP 客户端(如 Claude Desktop 或 Cursor)中使用自然语言与 AI 助手进行交互,从而使用笔记功能。
示例对话:
用户:添加一个明天早上九点开会的笔记
AI 助手:好的,已添加笔记。 [调用 'add_note' 工具]
用户:我有哪些笔记?
AI 助手:让我看看您的笔记。 [调用 'read_notes' 工具] 您的笔记内容如下:...
用户:我的最新一条笔记是什么?
AI 助手:您的最新一条笔记是: [使用 'notes://latest' 资源] ...
用户:请总结一下我的所有笔记
AI 助手: [使用 'note_summary_prompt' Prompt] 您的笔记总结如下:...
信息
分类
生产力应用