article
README
🚀 Jotdown - Notion 页创建 MCP 服务器及 mdBook 生成器
Jotdown 是一款模型上下文协议(MCP)服务器,它能让大型语言模型(LLMs)与 Notion 集成,还能生成 Markdown 书籍。它为 LLMs 提供了两大实用工具,助力实现各类内容管理和发布工作流程。
🚀 快速开始
Jotdown 使大型语言模型能够无缝集成到 Notion 和 Markdown 书籍生成系统中。以下将为你详细介绍其主要功能、安装步骤和使用方法。
✨ 主要特性
- 🌿 Notion 集成:可自动在 Notion 中创建或更新页面,便于存储结构化内容,如文章或其他类型的文档。
- 🌿 Mdbook 生成:能直接从内容中生成并管理 Markdown 书籍,包括生成
SUMMARY.md、README.md等必要文件以及各章节目录的 Markdown 文件。 - 🌿 MCP 支持:借助模型上下文协议维护交互中的上下文,实现更智能、一致的内容创建与更新。
📦 安装指南
先决条件
- Rust:需确保已安装 Rust,可从 rust-lang.org 进行安装。
- Notion API Token:要获取一个 Notion API 令牌(
内部集成密钥),用于与 Notion 集成。 - Claude Desktop:需安装 Claude 桌面或其他 MCP 客户端(如 Cline、Continue 等),并配置好 Notion 集成令牌。
安装步骤
- 克隆仓库:
git clone https://github.com/Harry-027/JotDown cd jotdown - 安装依赖项:
cargo build --release - 安装 mdbook CLI(mdbook 生成所需的工具):
cargo install mdbook - Notion 设置:
- 配置 Notion 连接(内部集成,访问您的 Notion 工作区),并复制
内部集成密钥以便后续使用。 - 在工作区中创建一个标题为
Jot It Down的页面,并与该连接共享,这是使集成正常运行的必要步骤。
- 配置 Notion 连接(内部集成,访问您的 Notion 工作区),并复制
- 配置 Claude 桌面(或其他 MCP 客户端)配置文件(用于 Notion 集成):
"mcp_configs": { "jotdown": { "name": "Jotdown Integration", "description": "Integration with Jotdown for content creation and management.", "config": { "notion_token": "your_notion_integration_token_here" } } } - 启动服务:
cargo run --release --bin server
💻 使用示例
基本用法
基本命令
- 创建新页面:
jotdown create-page "页面标题" "页面内容" - 更新现有页面:
jotdown update-page "页面ID" "新内容" - 生成 Markdown 书籍:
jotdown generate-book "书籍标题" "章节1标题 章节2标题 ..."
高级用法
示例
- 创建 Notion 页面
jotdown create-page "我的新页面" "这是我的第一个使用 Jotdown 创建的页面内容。" - 更新 Notion 页面
jotdown update-page "page_12345" "更新后的内容" - 生成 Markdown 书籍
jotdown generate-book "我的书籍" "第一章 第二章 第三章"
📚 详细文档
Jotdown 提供的工具
1. Notion 页面工具
LLMs 可使用 Notion 工具在 Notion 中创建或更新页面,方便存储结构化内容,如文章或其他类型的文档。
- 示例:
- 使用 LLM 生成的内容创建一个新的 Notion 页面。
- 更新现有 Notion 页面中的信息。
2. mdbook 工具
通过 mdbook 工具,LLMs 能自动从内容中生成 Markdown 书籍,处理章节的创建、结构管理,并添加 SUMMARY.md 文件以便导航。
- 示例:
- 基于 LLM 生成的内容生成新书。
- 自动生成带有正确链接的章节到
SUMMARY.md中。
⚠️ 注意事项
⚠️ 重要提示
- 确保您的 Notion 帐户有足够的权限来创建和编辑页面。
- 在生产环境中使用时,请妥善保管 API 令牌,避免泄露。
- 如果遇到问题,请检查日志文件或访问我们的 GitHub 仓库以获取支持。
希望您能顺利使用 Jotdown 实现内容管理和书籍生成!
扫码联系在线客服