运行手册-mcp服务器
项目介绍
Runbook MCP服务器
此MCP服务器与Runbook集成，允许列出、阅读和搜索文档。
组件
工具
get-article- 根据ID从数据库中检索文章。
- 必需输入：
articleUid（字符串）：要检索的文章ID。它总是以ar_开头。
list-articles- 列出指定书籍ID中的前100篇文章。结果不包括完整的文章内容，因为它们被截断到200个字符。您需要通过调用
get-article来检索完整的内容。 - 必需输入：
bookUid（字符串）：书籍ID。它总是以'bk_'开头。您可以使用`list-books`检索书籍列表。
- 可选输入：
articleName（字符串）：如果提供，则结果将按文章名称过滤。categoryUid（字符串）：类别ID。它总是以'ca_'开头。您可以使用`list-categories`检索类别列表。orderBy（字符串）：排序字段（updatedAt, createdAt, 'name', 或 'popularity'）。
- 列出指定书籍ID中的前100篇文章。结果不包括完整的文章内容，因为它们被截断到200个字符。您需要通过调用
create-article- 在指定书籍ID中创建一篇新文章。文章正文采用Markdown格式。文章将在书籍的根文件夹中创建。您可以根据其ID指定文章的类别，这些ID总是以'ca_'开头。您可以使用`list-books`检索书籍列表，使用`list-categories`检索类别列表。
- 必需输入：
bookUid（字符串）：书籍ID。它总是以'bk_'开头。您可以使用`list-books`检索书籍列表。name（字符串）：要创建的文章名称。
- 可选输入：
bodyMarkdown（字符串）：文章正文，采用Markdown格式。如果没有提供，则会创建一个空文章。categoryUids（数组）：分配给文章的类别的ID。每个ID都以'ca_'开头。您可以使用`list-categories`检索类别列表。
update-article- 根据ID更新现有文章。文章正文采用Markdown格式。您可以根据其ID指定文章的类别，这些ID总是以'ca_'开头。
- 必需输入：
articleUid（字符串）：要更新的文章ID。它总是以ar_开头。您可以使用`list-articles`检索文章列表。
- 可选输入：
name（字符串）：要更新的文章名称。bodyMarkdown（字符串）：文章正文，采用Markdown格式。如果没有提供，则正文不会被更新。categoryUids（数组）：分配给文章的类别的ID。每个ID都以'ca_'开头。您可以使用`list-categories`检索类别列表。
list-books- 列出组织中的前100本书籍。
- 可选输入：
bookName（字符串）：如果提供，则结果将按书籍名称过滤。
list-categories- 列出指定书籍ID中的前100个类别。
- 必需输入：
bookUid（字符串）：书籍ID。它总是以'bk_'开头。您可以使用`list-books`检索书籍列表。
search-articles- 使用关键词从Runbook搜索文章。结果不包括完整的文章内容，因为它们被截断到200个字符。您需要通过调用`get-article`来检索完整的内容。
- 必需输入：
keywords（字符串）：用于筛选文章的空间分隔关键词。如果提供了多个关键词，则返回匹配所有关键词的文章。使用当前语言的关键词。
- 可选输入：
scope（字符串）：书籍或工作区的ID。如果提供，则结果将按它们进行过滤。默认值：全部。limit（数字）：要检索的文章数量。offset（数字）：搜索结果的偏移量。orderBy（字符串）：排序字段（updatedAt, createdAt, 或 'score'）。默认值：score。
get-process- 根据书籍UID获取当前进程信息。
- 必需输入：
bookUid（字符串）：书籍ID。它总是以'bk_'开头。书籍类型必须是'workflow'。
- 可选输入：
runStateUid（字符串）：运行状态ID。它总是以'rs_'开头。如果没有提供，则使用第一个运行状态。
run-process- 此工具用于启动新的进程或继续现有的进程。如果未提供运行状态UID，则会创建一个新的进程。
- 必需输入：
bookUid（字符串）：书籍ID。它总是以'bk_'开头。书籍类型必须是'workflow'。articleUid（字符串）：文章ID。它总是以'ar_'开头。文章UID包含在`get-process`和`run-process`的返回值中。
- 可选输入：
runStateUid（字符串）：运行状态ID。它总是以'rs_'开头。如果没有提供，则会创建一个新的进程。propertyValues（对象）：传递给进程的属性值。这是一个键为字符串，值为字符串或字符串数组的对象。属性对应于文章正文中的`::::input`元素。只有type="checkbox"的输入元素可以使用字符串数组类型。
要求
- Node.js >= v20.0.0
与桌面应用集成
为了将此服务器与桌面应用集成，请在您的应用服务器配置中添加以下内容：
配置Claude Desktop
推荐：作为桌面扩展(.dxt)安装
为了最简单的设置，从发布页面下载并安装.dxt文件。这将自动在Claude Desktop中配置MCP服务器。有关桌面扩展的更多信息，请参阅Anthropic文档。
手动配置
或者，在您的claude_desktop_config.json中添加以下内容：
{
"mcpServers": {
"runbook": {
"command": "npx",
"args": [
"-y",
"@runbook-docs/mcp-server"
],
"env": {
"RUNBOOK_BASE_URL": "https://<YOUR_SUBDOMAIN>.runbook.jp",
"RUNBOOK_API_TOKEN": "your-api-token"
}
}
}
}
配置Cursor
使用以下命令添加MCP服务器。
npx -y @runbook-docs/mcp-server --api-token=your-api-tokan --base-url=https://yourdomain.runbook.jp
Markdown格式
在创建或更新文章时，正文内容使用Markdown格式，支持以下元素：
- 标题：
## H2，### H3，#### H4。不要使用# H1，因为它保留给文章标题。 - 粗体：
**粗体文本** - 斜体：
_斜体文本_ - 列表：
- 项目或1. 编号项目 - 链接：
[文本](网址) - 代码块：
``` 代码 ``` - 表格：
| 列1 | 列2 | | --- | --- | | 数据 | 数据 | - 引用：
> 引用文本 - 提示框：
:::callout info 文本 ::::::callout warning 文本 ::: - SVG图像：
许可证
此MCP服务器根据MIT许可证授权。这意味着您可以自由地使用、修改和分发该软件，但须遵守MIT许可证的条款和条件。如需更多详情，请参见项目存储库中的LICENSE文件。