Roam Research代理技能

通过MCP服务器为代理提供Roam Research图数据库操作技能,包括批量操作、日期格式处理和Roam风格Markdown语法。

  • by avelino
  • Shell
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 avelino/roamresearch-plugin-skill

使用说明

漫游研究-代理技能

通过MCP服务器处理漫游研究图的代理技能。教导代理如何执行Roam que ele vai errar sem contexto——批处理操作、日期格式、, ((uid)) 对比 [[page]],以及Roam风味的Markdown。

代理人学到了什么

  • roam_process_batch_actions 是规范的编写工具(v1.36.0+);个别工具已弃用
  • 每日页面标题使用 March 30th, 2026 格式,而非ISO日期
  • ((uid)) =块参考(9-char), [[title]] =页面链接--永不交换
  • 始终通过以下方式加载Roam Markdown备忘单 roam_get_resource 写作之前
  • 始终在创建前获取,以避免重复

先决条件

MCP服务器设置

这项技能需要 漫游 MCP服务器——它通过 模型上下文协议.

1.获取Roam API令牌

首选 Roam → 设置→ 图→ API令牌 并创建新令牌。

2.配置MCP服务器

将以下内容添加到MCP客户端配置中:

克劳德代码 (.mcp.json 在您的项目根目录中或 ~/.claude.json 全球):

{
  "mcpServers": {
    "roam": {
      "command": "npx",
      "args": ["-y", "roam-tui@latest", "--mcp"],
      "env": {
        "ROAM_GRAPH_NAME": "your-graph-name",
        "ROAM_GRAPH_API__TOKEN": "roam-graph-token-XXXXX"
      }
    }
  }
}

克劳德桌面版 (claude_desktop_config.json):

{
  "mcpServers": {
    "roam": {
      "command": "npx",
      "args": ["-y", "roam-tui@latest", "--mcp"],
      "env": {
        "ROAM_GRAPH_NAME": "your-graph-name",
        "ROAM_GRAPH_API__TOKEN": "roam-graph-token-XXXXX"
      }
    }
  }
}

如果你有 roam-tui 本地安装(通过 cargo install 或来源),您可以使用 "command": "roam", "args": ["--mcp"] 相反。

完整文档: github.com/avelino/roam-tui

3.验证

配置后,重新启动代理并确认 roam_* 工具可用。快速测试:

/roam
> search for "test" in my graph

技能安装

快速安装

npx skills add https://github.com/avelino/roamresearch-plugin-skill --skill roam

设置

选项1:安装程序脚本(推荐)

git clone https://github.com/avelino/roamresearch-plugin-skill.git
cd roamresearch-plugin-skill
./install-skill.sh

选择您的提供商和安装目标。

选项2:手动安装

Claude Code
git clone https://github.com/avelino/roamresearch-plugin-skill.git
cd roamresearch-plugin-skill

mkdir -p your-project/.claude/skills/roam
cp -r .agents/skills/roam/* your-project/.claude/skills/roam/

mkdir -p your-project/.claude/commands
cp .claude/commands/roam.md your-project/.claude/commands/
Codex (OpenAI) / Windsurf
git clone https://github.com/avelino/roamresearch-plugin-skill.git
cd roamresearch-plugin-skill

mkdir -p your-project/.agents/skills/roam
cp -r .agents/skills/roam/* your-project/.agents/skills/roam/

结构

roam/
├── SKILL.md                 ← 15 critical rules + tool table + patterns
└── reference/
    ├── batch-actions.md     ← roam_process_batch_actions schema
    └── roam-markdown.md     ← Roam syntax + daily page date format

用法

安装后,调用以下技能:

提供者 命令
克劳德代码 /roam
食品法典委员会 $roam
风帆冲浪 @roam

许可证

麻省理工学院