Cosense MCP Server 使用说明

项目简介

Cosense MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它将 Cosense 知识库中的页面资源暴露给 LLM (大型语言模型) 客户端。通过实现 MCP 协议，该服务器允许 LLM 应用以统一的方式访问 Cosense 页面，并提供了一系列工具来检索、管理和编辑这些页面，从而实现更智能化的知识交互和应用集成。

主要功能点

资源管理: 将 Cosense 项目中的页面作为 MCP 资源进行托管，允许 LLM 客户端读取页面内容。
工具集成: 提供了一组实用的工具，使 LLM 能够执行以下操作：
- 检索页面内容 ('get_page'): 根据页面标题获取指定页面的详细内容。
- 列出所有页面 ('list_pages'): 获取 Cosense 项目中所有页面的简要信息列表。
- 搜索页面 ('search_pages'): 根据关键词在 Cosense 项目中搜索相关页面。
- 插入内容到页面 ('insert_lines'): 在指定页面的特定行后插入新的文本内容，实现页面编辑功能。
标准 MCP 协议: 遵循 MCP 协议规范，通过 JSON-RPC 协议与客户端通信，保证了与各种 MCP 客户端的兼容性。

安装步骤

克隆仓库

git clone https://github.com/yosider/cosense-mcp-server.git
cd cosense-mcp-server

安装依赖
```
npm install
```
构建项目
```
npm run build
```

服务器配置 (MCP 客户端配置)

为了让 MCP 客户端能够连接到 Cosense MCP Server，您需要在客户端的配置文件中添加以下服务器配置信息。请注意，MCP 客户端需要根据此配置启动和连接服务器。

{
  "mcpServers": {
    "cosense-mcp-server": {
      "command": "npx",
      "args": ["-y", "@yosider/cosense-mcp-server"],
      "env": {
        "COSENSE_PROJECT_NAME": "your_project_name",  // 替换为您的 Cosense 项目名称
        "COSENSE_SID": "your_sid"                   // 替换为您的 Cosense Session ID (用于读写私有页面，可选但建议配置)
      }
    }
  }
}

说明:

'"command": "npx"' 和 '"args": ["-y", "@yosider/cosense-mcp-server"]' 指示 MCP 客户端使用 'npx' 命令运行发布在 npm 仓库的 '@yosider/cosense-mcp-server' 包。
'"env"' 部分用于设置环境变量，其中：
- '"COSENSE_PROJECT_NAME"': 必填，您需要替换为您的 Cosense 项目的名称。
- '"COSENSE_SID"': 可选但推荐，如果您需要访问或修改私有页面，或者进行页面写入操作（如 'insert_lines' 工具），则需要提供 Cosense Session ID。请谨慎保管 Session ID，详情请参考 scrapboxlab/connect.sid。

如果您选择从源码运行服务器 (在克隆并构建项目后):

{
  "mcpServers": {
    "cosense-mcp-server": {
      "command": "node",
      "args": ["./build/index.js"],
      "env": {
        "COSENSE_PROJECT_NAME": "your_project_name",  // 替换为您的 Cosense 项目名称
        "COSENSE_SID": "your_sid"                   // 替换为您的 Cosense Session ID (用于读写私有页面，可选但建议配置)
      }
    }
  }
}