废料箱cosense mcp
日语文档
概述
MCP服务器 Cosense(前身为Scrapbox).
| 工具 | 描述 | 需要授权 |
|---|---|---|
get_page |
获取页面内容、元数据和链接 | 用于私人项目 |
list_pages |
浏览具有排序和分页功能的页面(最多1000个) | 适用于私人项目 |
search_pages |
关键字突出显示的全文搜索(最多100个结果) | 适用于私人项目 |
create_page |
通过WebSocket API创建带有Markdown/Scrapbox主体的页面 | 是 |
get_page_url |
为页面生成直接URL | 否 |
insert_lines |
在页面中的指定行后插入文本 | 是 |
get_smart_context |
获取AI优化格式的页面及其链接页面(1跳/2跳) | 是 |
create_page 和 insert_lines 支持一个 format 参数("markdown" 或 "scrapbox")以控制内容转换。
快速开始
桌面扩展(.mcpb)——最简单
- 下载
scrapbox-cosense-mcp.mcpb从 GitHub发布 - 双击--Claude Desktop打开安装对话框
- 输入您的项目名称(以及私有项目的会话ID)
Claude代码插件
- 添加市场:```
/plugin marketplace add worldnine/scrapbox-cosense-mcp
1. 安装插件:```
/plugin install scrapbox-cosense@worldnine-scrapbox-cosense-mcp
默认情况下全局安装。使用 --scope project 或 --scope local 对于其他范围。
1. 在设置文件中设置环境变量:```json
{
"env": {
"COSENSE_PROJECT_NAME": "your_project_name",
"COSENSE_SID": "your_sid"
}
}
|文件|范围|
|------|-------|
| `~/.claude/settings.json` |所有项目(全球)|
| `.claude/settings.local.json` |仅此项目(忽略)|
该插件包括MCP服务器配置和 `/cosense` CLI操作技能。
### 克劳德代码(手动MCP设置)
如果你更喜欢手动配置而不是插件:```bash
claude mcp add scrapbox-cosense-mcp \
-e COSENSE_PROJECT_NAME=your_project \
-e COSENSE_SID=your_sid \
-- npx -y scrapbox-cosense-mcp
克劳德桌面/其他MCP客户端
添加到您的配置文件中:
| 客户端 | 配置文件 |
|---|---|
| 克劳德桌面(macOS) | ~/Library/Application Support/Claude/claude_desktop_config.json |
| 克劳德桌面(Windows) | %APPDATA%/Claude/claude_desktop_config.json |
| 光标 | .cursor/mcp.json (项目根) |
| 风帆冲浪 | ~/.codeium/windsurf/mcp_config.json |
{
"mcpServers": {
"scrapbox-cosense-mcp": {
"command": "npx",
"args": ["-y", "scrapbox-cosense-mcp"],
"env": {
"COSENSE_PROJECT_NAME": "your_project_name",
"COSENSE_SID": "your_sid"
}
}
}
}
从源代码构建```bash
git clone https://github.com/worldnine/scrapbox-cosense-mcp.git
cd scrapbox-cosense-mcp
npm install && npm run build
## 配置
### 必需
|变量|描述|
|----------|-------------|
| `COSENSE_PROJECT_NAME` |您的Scrapbox/Cosense项目名称|
| `COSENSE_SID` |会话ID(`connect.sid` cookie)用于私人项目-- 如何获得它 |
### 可选的
|变量|默认值|描述|
|----------|---------|-------------|
| `API_DOMAIN` | `scrapbox.io` |API域|
| `SERVICE_LABEL` | `cosense (scrapbox)` |在工具描述中显示名称|
| `COSENSE_PAGE_LIMIT` | `100` |初始页面获取限制(1-1000)|
| `COSENSE_SORT_METHOD` | `updated` |初始排序:已更新、已创建、已访问、已链接、视图、标题|
| `COSENSE_TOOL_SUFFIX` |--|多个实例的工具名称后缀(例如。 `main` → `get_page_main`) |
| `COSENSE_CONVERT_NUMBERED_LISTS` | `false` |在Markdown转换中将编号列表转换为项目符号列表|
| `COSENSE_EXCLUDE_PINNED` | `false` |从初始资源列表中排除固定页面|
## CLI使用情况
同一个二进制文件也可以作为独立的CLI使用:```bash
scrapbox-cosense-mcp get "Page Title"
scrapbox-cosense-mcp search "keyword"
scrapbox-cosense-mcp list --sort=updated --limit=20
scrapbox-cosense-mcp create "New Page" --body="Markdown content"
scrapbox-cosense-mcp insert "Page" --after="target line" --text="new text"
scrapbox-cosense-mcp url "Page Title"
| 标志 | 描述 |
|---|---|
--compact |
令牌高效紧凑输出(推荐用于AI代理) |
--project=NAME |
覆盖项目名称 |
--json |
输出为JSON |
--help |
显示帮助(支持 --help 详情) |
多个项目
所有工具都接受可选 projectName 参数,用于从单个服务器定位不同的项目。对于具有不同凭据的多个私有项目,请使用以下命令运行单独的服务器实例 COSENSE_TOOL_SUFFIX.
看 docs/多项目.md 查看详细的配置示例。
发展
| 命令 | 描述 |
|---|---|
npm run build |
构建(TypeScript→ JavaScript) |
npm run watch |
开发过程中的自动重建 |
npm test |
运行测试套件 |
npm run lint |
运行ESLint |
npm run inspector |
使用MCP检查器进行调试 |
贡献
- 从以下位置创建要素分支
main - 为您的更改添加测试
- 跑
npm run lint && npm test - 创建拉取请求——CI自动运行
许可证
麻省理工学院
