Scrapbox Cosense MCP 服务器使用说明

项目简介

Scrapbox Cosense MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在连接大型语言模型 (LLM) 与 Scrapbox 知识库。通过此服务器,LLM 客户端可以安全、便捷地访问和操作 Scrapbox 项目中的页面数据,实现知识检索、内容获取和页面创建等功能。

主要功能点

  • 获取页面内容 (get_page): 允许 LLM 根据页面标题获取 Scrapbox 页面的完整内容,包括文本、元数据、链接和编辑信息,为 LLM 提供丰富的上下文信息。
  • 列出项目页面 (list_pages): 支持 LLM 获取 Scrapbox 项目中的页面列表,并提供多种排序选项(按更新时间、创建时间等),方便 LLM 浏览和选择页面资源。
  • 搜索项目页面 (search_pages): 提供全文搜索功能,允许 LLM 在 Scrapbox 项目中检索包含特定关键词的页面,支持基本搜索、AND/OR/NOT 搜索和短语搜索,帮助 LLM 快速定位所需信息。
  • 创建页面链接 (create_pages): 支持 LLM 生成用于创建新 Scrapbox 页面的 URL,用户可以通过浏览器打开 URL 并创建页面,实现从 LLM 到 Scrapbox 的内容创作桥梁。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/worldnine/scrapbox-cosense-mcp.git
    cd scrapbox-cosense-mcp
  2. 安装依赖:
    npm install
  3. 构建服务器:
    npm run build

服务器配置

要将 Scrapbox Cosense MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供以下 JSON 配置信息。请根据您的实际情况修改以下参数:

{
  "mcpServers": {
    "scrapbox-cosense-mcp": {
      "command": "npx",
      "args": ["github:worldnine/scrapbox-cosense-mcp"],
      "env": {
        "COSENSE_PROJECT_NAME": "your_project_name",  // **必填**: 您的 Scrapbox 项目名称
        "COSENSE_SID": "your_sid",                   // **可选**: 您的 Scrapbox 会话 ID (访问私有项目时必填)
        "COSENSE_PAGE_LIMIT": "25",                  // **可选**: 初始页面获取数量限制 (默认: 100, 范围: 1-1000)
        "COSENSE_SORT_METHOD": "updated",              // **可选**: 初始页面排序方式 (默认: "updated", 可选值: "updated", "created", "accessed", "linked", "views", "title")
        "SERVICE_LABEL": "scrapbox(cosense)"         // **可选**: 服务标签 (默认: "cosense(scrapbox)")
      }
    }
  }
}

配置参数说明:

  • 'command': MCP 服务器的启动命令,这里使用 'npx' 来执行 npm 包。
  • 'args': 'npx' 命令的参数,指定要执行的 npm 包为 GitHub 仓库地址 'github:worldnine/scrapbox-cosense-mcp'。
  • 'env': 环境变量配置,用于服务器运行时读取:
    • 'COSENSE_PROJECT_NAME': 必须设置,您的 Scrapbox 项目名称。
    • 'COSENSE_SID': 可选,访问私有 Scrapbox 项目时需要设置,用于身份验证。您需要从浏览器 Cookie 中获取 'connect.sid' 的值。
    • 'COSENSE_PAGE_LIMIT': 可选,设置服务器启动时初始获取的页面数量上限,可以根据需求调整,但需在 1-1000 范围内。
    • 'COSENSE_SORT_METHOD': 可选,设置初始页面列表的排序方式,默认为按更新时间排序。
    • 'SERVICE_LABEL': 可选,自定义服务在 MCP 客户端中显示的标签。

请注意: 您需要将上述 JSON 配置添加到您的 MCP 客户端的配置文件中。例如,对于 Claude Desktop,配置文件路径为:

  • MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

基本使用方法

配置完成后,您的 MCP 客户端即可连接到 Scrapbox Cosense MCP 服务器。您可以通过客户端的功能调用服务器提供的工具,例如:

  • 使用 'get_page' 工具并输入页面标题,即可获取 Scrapbox 页面的内容。
  • 使用 'list_pages' 工具可以浏览 Scrapbox 项目中的页面列表。
  • 使用 'search_pages' 工具并输入关键词,即可在 Scrapbox 项目中搜索相关页面。
  • 使用 'create_page' 工具并输入页面标题和内容,可以生成创建新页面的链接,然后在浏览器中打开该链接创建页面。

具体操作方式请参考您使用的 MCP 客户端的文档。

信息

分类

生产力应用