Runbook MCP server

Runbook MCP 服务

此 MCP 服务与 Runbook 集成，可用于列出、读取和搜索文档。

组件

工具

• get-article
  • 根据文章 ID 从数据库中检索文章。
  • 必填输入：
    • articleUid (string)：要检索的文章 ID。始终以 ar_ 开头。
• list-articles
  • 列出指定 ID 的知识书中排名前 100 的文章。结果不包含完整文章正文，因为正文会截断至 200 个字符。你需要调用 `get-article` 来检索完整内容。
  • 必填输入：
    • bookUid (string)：知识书 ID。始终以 'bk_' 开头。你可以使用 `list-books` 检索知识书列表。
  • 可选输入：
    • articleName (string)：如果提供，结果将按文章名称筛选。
    • categoryUid (string)：分类 ID。始终以 'ca_' 开头。你可以使用 `list-categories` 检索分类列表。
    • orderBy (string)：排序字段（updatedAt、createdAt、'name' 或 'popularity'）。
• create-article
  • 在指定 ID 的知识书中创建新文章。文章正文采用 Markdown 格式。文章将在知识书的根文件夹中创建。你可以通过分类 ID 为文章指定分类，这些 ID 始终以 'ca_' 开头。你可以使用 `list-books` 和 `list-categories` 检索知识书和分类列表。
  • 必填输入：
    • bookUid (string)：知识书 ID。始终以 'bk_' 开头。你可以使用 `list-books` 检索知识书列表。
    • name (string)：要创建的文章名称。
  • 可选输入：
    • bodyMarkdown (string)：Markdown 格式的文章正文。如果未提供，将创建一篇空文章。
    • categoryUids (array)：要分配给文章的分类 ID。每个 ID 都以 'ca_' 开头。你可以使用 `list-categories` 检索分类列表。
• update-article
  • 根据文章 ID 更新现有文章。文章正文采用 Markdown 格式。你可以通过分类 ID 为文章指定分类，这些 ID 始终以 'ca_' 开头。
  • 必填输入：
    • articleUid (string)：要更新的文章 ID。始终以 ar_ 开头。你可以使用 `list-articles` 检索文章列表。
  • 可选输入：
    • name (string)：要更新的文章名称。
    • bodyMarkdown (string)：Markdown 格式的文章正文。如果未提供，则不会更新正文。
    • categoryUids (array)：要分配给文章的分类 ID。每个 ID 都以 'ca_' 开头。你可以使用 `list-categories` 检索分类列表。
• list-books
  • 列出组织中排名前 100 的知识书。
  • 可选输入：
    • bookName (string)：如果提供，结果将按知识书名称筛选。
• list-categories
  • 列出指定 ID 的知识书中排名前 100 的分类。
  • 必填输入：
    • bookUid (string)：知识书 ID。始终以 'bk_' 开头。你可以使用 `list-books` 检索知识书列表。
• get-folder
  • 检索知识书中的文件夹及其祖先文件夹和子项（子文件夹和文章）。如果未提供 folderUid，则检索知识书的根文件夹。结果中的文章仅包含名称和 UID。要获取完整文章正文，请调用 `get-article`。
  • 必填输入：
    • bookUid (string)：知识书 ID。始终以 'bk_' 开头。你可以使用 `list-books` 检索知识书列表。
  • 可选输入：
    • folderUid (string)：文件夹 ID。始终以 'fo_' 开头。如果未提供，则使用知识书的根文件夹。
• search-articles
  • 使用 Runbook 中的关键词搜索文章。结果不包含完整文章正文，因为正文会截断至 200 个字符。你需要调用 `get-article` 来检索完整内容。
  • 必填输入：
    • keywords (string)：以空格分隔的筛选文章关键词。如果提供多个关键词，将返回匹配所有关键词的文章。关键词请使用当前语言。
  • 可选输入：
    • scope (string)：知识书或工作区的 ID。如果提供，结果将按其筛选。默认值：全部。
    • limit (number)：要检索的文章数量。
    • offset (number)：搜索结果的偏移量。
    • orderBy (string)：排序字段（updatedAt、createdAt 或 'score'）。默认值：score。
• list-assigned-processes
  • 获取分配给当前用户且尚未处理的进行中流程（工作流运行状态）列表。最多返回 20 条结果，每条包含运行状态 UID（以 'rs_' 开头）、状态、创建日期及所属知识书。使用返回的 book.uid 和运行状态 uid 调用 get-process，以读取流程详情。
  • 无输入。
• get-process
  • 根据知识书 UID 获取当前流程信息。
  • 必填输入：
    • bookUid (string)：知识书 ID。始终以 'bk_' 开头。知识书类型必须为 'workflow'。
  • 可选输入：
    • runStateUid (string)：运行状态 ID。始终以 'rs_' 开头。如果未提供，则使用第一个运行状态。
• run-process
  • 此工具用于启动新流程或继续现有流程。如果未提供运行状态 UID，则会创建新流程。
  • 必填输入：
    • bookUid (string)：知识书 ID。始终以 'bk_' 开头。知识书类型必须为 'workflow'。
    • articleUid (string)：文章 ID。始终以 'ar_' 开头。文章 UID 包含在 `get-process` 和 `run-process` 的返回值中。
  • 可选输入：
    • runStateUid (string)：运行状态 ID。始终以 'rs_' 开头。如果未提供，则会创建新流程。
    • propertyValues (object)：要传递给流程的属性值。此对象的键为字符串，值为字符串或 string[]。属性对应于文章正文中的 `::::input` 元素。只有 type="checkbox" 的输入元素可以使用 string[] 类型。

要求

• Node.js >= v20.0.0

与桌面应用搭配使用

要将此服务集成到桌面应用中，请将以下内容添加到应用的服务配置中：

配置 Claude Desktop

推荐：安装为桌面扩展（.mcpb）

最简单的设置方式是从发布页面下载并安装 .mcpb 文件。此操作会自动在 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，因为它专用于文章标题。
• 粗体：**bold text**
• 斜体：_italic text_
• 列表：- item 或 1. numbered item
• 链接：[text](url)
• 代码块：

  ```
  code
  ```
  

• 表格：

  | col1 | col2 |
  | --- | --- |
  | data | data |
  

• 引用块：> quoted text
• 提示框：

  :::callout info
  text
  :::
  

  :::callout warning
  text
  :::
  

• 图表：

  ```mermaid
  graph TD;
  ```
  

许可证

此 MCP 服务采用 MIT License 许可。这意味着您可以自由使用、修改和分发该软件，但须遵守 MIT License 的条款和条件。有关详情，请参阅项目仓库中的 LICENSE 文件。