scrapbox-cosense-mcp

scrapbox-cosense-mcp

site icon
2025.04.17 12
TypeScriptScrapbox 管理内容协作交流协作
scrapbox-cosense-mcp 是一个为 [cosense/scrapbox](https://cosen.se) 提供的 MCP 服务器。它主要用于从 Scrapbox 项目中获取、搜索和管理页面内容。
View on GitHub

Overview

基本能力

产品定位

scrapbox-cosense-mcp 是一个用于管理和操作 Scrapbox 项目的 MCP 服务器,提供页面内容获取、搜索和创建功能。

核心功能

  • get_page
  • 从 cosense/Scrapbox 获取页面内容
    • 输入: 页面标题
    • 输出: 页面内容、元数据、链接和编辑者信息
  • list_pages
  • 获取项目中的页面列表(最多 1000 页)
    • 输出: 项目中的页面标题列表
  • search_pages
  • 对项目中的所有页面进行全文搜索(最多 100 页)
    • 支持基本搜索、AND 搜索、OR 搜索和 NOT 搜索
    • 输出: 搜索结果中的页面标题列表
  • create_pages
  • 生成页面 URL
    • 输入: 页面标题和可选的正文文本
    • 输出: 可以在浏览器中打开的 URL

适用场景

  • 需要从 Scrapbox 项目中批量获取页面内容的场景
  • 需要对 Scrapbox 项目进行全文搜索的场景
  • 需要自动化创建 Scrapbox 页面的场景

工具列表

  • get_page: 获取单个页面的详细内容
  • list_pages: 列出项目中的所有页面
  • search_pages: 在项目中进行全文搜索
  • create_pages: 创建新页面

常见问题解答

  1. 如何访问私有项目?
  2. 需要设置 COSENSE_SID 环境变量进行认证

  3. 如何调整页面获取限制?

  4. 通过 COSENSE_PAGE_LIMIT 环境变量设置(1-1000)

  5. 如何调试?

  6. 推荐使用 MCP Inspector

使用教程

使用依赖

安装 Node.js 和 npm

安装教程

git clone https://github.com/worldnine/scrapbox-cosense-mcp.git
cd scrapbox-cosense-mcp
npm install
npm run build

调试方式

npm run inspector

环境变量配置

必须环境变量

  • COSENSE_PROJECT_NAME: 项目名称
  • COSENSE_SID: Scrapbox/Cosense 认证会话 ID(私有项目必需)

可选环境变量

  • API_DOMAIN: API 域名(默认: "scrapbox.io")
  • SERVICE_LABEL: 服务标识(默认: "cosense (scrapbox)")
  • COSENSE_PAGE_LIMIT: 初始页面获取限制(1-1000,默认: 100)
  • COSENSE_SORT_METHOD: 初始页面获取顺序(updated/created/accessed/linked/views/title,默认: updated)

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。