使用说明
项目简介
Notion MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当了 AI 模型与 Notion 工作空间之间的桥梁。通过这个服务器,AI 模型可以安全、便捷地访问和操作您的 Notion 内容,实现例如内容搜索、数据库查询、页面创建和编辑等功能。这为构建智能化的 Notion 应用和提升 AI 助手的能力提供了强大的支持。
主要功能点
- 全面的 Notion API 支持: 基于官方 Notion SDK,提供对 Notion API 的完整支持,确保功能全面且与官方同步更新。
- MCP 协议兼容: 完全遵循 Model Context Protocol 协议,可以无缝集成到各种支持 MCP 协议的 AI 客户端,如 Claude、Cursor 等。
- 丰富的工具集: 内置多项实用工具,涵盖 Notion 的核心操作,包括:
- 搜索 (Search): 在 Notion 中查找页面或数据库。
- 数据库 (Databases): 查询和检索数据库条目,支持筛选和排序。
- 页面 (Pages): 创建、检索和更新页面,管理页面内容。
- 块 (Blocks): 管理页面内容块,如段落、列表等,实现精细化内容操作。
- 用户 (Users): 列出和获取 Notion 用户信息。
- 评论 (Comments): 创建和列出页面及块的评论。
- 链接预览 (Link Previews): 为URL创建链接预览,增强内容展示。
- 易于配置: 支持多种配置方式,包括命令行参数、环境变量和 .env 文件,方便用户根据不同场景进行部署。
- 详细的错误处理: 提供清晰的错误信息,帮助用户快速定位和解决问题。
安装步骤
-
创建 Notion 集成 (Integration)
- 访问 https://www.notion.so/my-integrations 并创建一个新的集成。
- 复制生成的 API 密钥 (API key),后续配置服务器时需要使用。
-
连接 Notion 页面到集成
- 对于希望通过 AI 访问的 Notion 页面或数据库,您需要显式地将其共享给您创建的集成。
- 打开需要共享的页面或数据库,点击右上角的 "分享" 按钮。
- 在 "添加人员、群组或集成" 输入框中,选择您创建的集成应用。
- 点击 "邀请" 按钮。
- 对所有需要 AI 访问的页面和数据库重复此步骤。请注意,父页面不会自动授予子页面的访问权限,每个页面和数据库都需要单独共享。
-
安装 MCP 服务器
- 确保您的电脑已安装 Node.js 和 npm (或 yarn)。
- 打开终端,运行以下命令安装 'mcp-server-notion':
请将 'your-notion-integration-key' 替换为您在步骤 1 中复制的 API 密钥。npx @ramidecodes/mcp-server-notion@latest -y --api-key=your-notion-integration-key
服务器配置
MCP 服务器需要配置在 MCP 客户端中,以便客户端能够连接并使用服务器提供的功能。以下是 JSON 格式的配置信息示例,适用于 Claude Desktop, Cursor AI, Claude.ai 等支持 MCP 的客户端:
{ "name": "Notion", // MCP 服务器的名称,可以自定义 "command": { "executable": "npx", // 运行命令的可执行程序,通常为 npx "args": [ "@ramidecodes/mcp-server-notion@latest", // MCP 服务器的 npm 包名 "-y", // 自动确认提示,无需手动输入 yes "--api-key=your-notion-integration-key" // Notion API 密钥,请替换为您的密钥 ], "env": {} // 环境变量,如果使用 .env 文件配置 API 密钥,此处可以为空 } }
配置步骤(以 Claude Desktop 为例):
- 打开 Claude Desktop 的设置 (Settings)。
- 导航到 "Advanced" -> "Model Context Protocol"。
- 点击 "Add Server",将上述 JSON 配置粘贴到配置框中,并确保将 'your-notion-integration-key' 替换为您的 Notion API 密钥。
- 点击 "Save" 保存配置。
对于 Cursor AI 和 Claude.ai (Web),配置步骤类似,请参考 README.md 中的 "Setup Instructions" 部分。
基本使用方法
成功配置并启动 Notion MCP Server 后,您可以在 AI 客户端中通过自然语言指令或预设的 Prompt 模板来调用服务器提供的工具,与 Notion 工作空间进行交互。
例如,您可以指示 AI 助手:
- "在 Notion 中搜索关于 '项目计划' 的页面" (对应 'search' 工具)
- "查询 Notion 数据库 '任务列表' 中状态为 '待办' 的任务" (对应 'query-database' 工具)
- "在 Notion 页面 '会议记录' 中创建一个新的段落,内容为 '会议总结要点...'" (对应 'append-blocks' 工具)
具体的工具使用方法和参数,请参考仓库的 Tools Documentation (如果仓库中包含此文档,请用户自行查看仓库文档,此处仓库中没有,可以省略).
提示:
- 首次使用前,请务必完成 Notion 集成创建和页面共享步骤,确保服务器有权访问您的 Notion 内容。
- 如果遇到连接问题,请检查 API 密钥是否正确配置,以及网络连接是否正常。
- 可以通过添加 '--verbose' 参数启动服务器,查看详细的日志输出,辅助问题排查。
信息
分类
生产力应用