README
🚀 Notion MCP 服务器
Notion MCP 服务器是一个基于模型上下文协议(MCP)的工具,可与 Notion 平台进行交互,支持对页面、块、数据库和评论的操作。
🚀 快速开始
克隆仓库
git clone https://github.com/awkoy/notion-mcp-server.git
cd notion-mcp-server
安装依赖
npm install
设置环境变量
创建一个 .env 文件:
NOTION_TOKEN=your_notion_api_key
NOTION_PAGE_ID=your_notion_page_id
构建项目
npm run build
运行检查工具
npm run inspector
✨ 主要特性
Notion MCP 服务器提供了对 Notion 平台页面、块、数据库和评论的操作支持,基于模型上下文协议(MCP),能高效地与 Notion 进行交互。
📦 安装指南
- 克隆仓库。
- 安装依赖。
- 设置环境变量。
- 启动服务器或检查工具。
💻 使用示例
基础用法
按照上述安装指南完成安装和配置后,即可使用 Notion MCP 服务器与 Notion 平台进行交互。
📚 详细文档
开发指南
代码结构
index.ts:主入口文件。tools/:包含与 Notion API 交互的工具模块。schemas/:用于输入输出验证的 Zod 模式文件。types/:定义自定义类型和接口。
开发步骤
- 克隆仓库并安装依赖。
- 根据需要修改代码或添加新功能。
- 使用检查工具调试和测试。
- 构建项目以生成生产版本。
故障排除
常见问题
- 认证错误:确认 Notion 令牌具有正确的权限,并且已启用相关页面/数据库的访问。
- 页面访问问题:确保集成已添加到您要访问的页面中。
- 速率限制:优化请求,使用批处理操作以提高效率。
贡献指南
欢迎贡献!请按照以下步骤提交 Pull Request:
- Fork 仓库。
- 创建功能分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m '添加很棒的功能')。 - 推送到分支 (
git push origin feature/amazing-feature)。 - 提交 Pull Request。
🔧 技术细节
- 构建技术:使用 TypeScript 和 MCP SDK(版本 1.7.0+)。
- 依赖库:集成 Notion 官方客户端库 (
@notionhq/client,版本 2.3.0+)。 - 协议遵循:符合模型上下文协议规范。
📄 许可证
本项目遵循 MIT 许可证,详细内容请查看 LICENSE 文件。
Scan to contact