README
🚀 Memos MCP 服务器
这是一个 Model Context Protocol (MCP) 服务器,其作用是将 Memos 集成到支持 MCP 协议的 AI 助手(例如 Claude)中。
✨ 主要特性
- 可使用关键词搜索笔记。
- 能够创建新的笔记,并且可以自定义可见性设置和标签。
- 可根据 ID 获取特定笔记。
- 能获取用户信息。
🚀 快速开始
📦 安装指南
Claude Desktop 设置
- 安装 Claude Desktop
- 下载 Claude Desktop。
- 确保使用的是最新版本(菜单:Claude -> 检查更新...)。
- 配置 MCP 服务器
{ "mcpServers": { "memos": { "command": "npx", "args": [ "memos-mcp-server" ], "env": { "MEMOS_URL": "https://your-memos-instance.com", "MEMOS_API_KEY": "your_api_key" } } } }
📚 详细文档
🛠️ 可用工具
search_memo
使用关键词搜索笔记。
参数:
| 属性 | 详情 |
| ---- | ---- |
| key_word | 字符串类型,在笔记内容中搜索的关键词 |
| state | 字符串类型,可选,笔记的状态(默认:"NORMAL",也可以是 "ARCHIVED") |
create_memo
创建新的笔记。
参数:
| 属性 | 详情 |
| ---- | ---- |
| content | 字符串类型,笔记内容 |
| visibility | 字符串类型,可选,可见性设置(默认:"PRIVATE",选项:"PUBLIC", "PROTECTED", "PRIVATE") |
| tags | 字符串数组类型,可选,笔记的标签列表 |
get_memo
根据 ID 获取特定笔记。
参数:
| 属性 | 详情 |
| ---- | ---- |
| name | 字符串类型,笔记名称,格式为 memos/{id} 或仅数字形式的 ID |
get_user
获取当前用户信息。
🔧 技术细节
🧪 开发
该项目运用 TypeScript 和 FastMCP 框架进行 MCP 服务器开发。
设置
# 安装依赖项
npm install
# 复制示例环境文件并设置环境变量
cp .env.example .env
# 编辑 .env 文件以配置 Memos API 的详细信息
开发模式
npm run dev
构建
npm run build
生产服务器运行
npm start
使用 mcp-cli 测试
最快的方式是使用 mcp-cli 进行测试和调试你的服务器:
npx fastmcp dev src/server.ts
这是使用 mcp-cli 在终端中测试和调试你的 MCP 服务器的快速方法。
使用 MCP Inspector 检查
你还可以使用官方的 MCP Inspector 通过 Web UI 检查你的服务器:
npx fastmcp inspect src/server.ts
🤝 贡献
欢迎贡献、问题和功能请求!你可以访问 issues 页面。
📄 许可证
MIT License - 版权所有 (c) 2025 Stephen J. Li
扫码联系在线客服