Runbook MCP server

Runbook MCP server

site icon
2025.04.03 1
JavaScript文档管理文档检索内容生成开发效率
Runbook MCP server 是一个与Runbook平台集成的服务,主要用于文档的列表、读取和搜索。它提供了多种工具来帮助用户高效地管理和检索文档内容。
View on GitHub

Overview

基本能力

产品定位

Runbook MCP server 是一个文档管理和检索工具,旨在帮助用户高效地访问和组织Runbook平台上的文档内容。

核心功能

  • 文档检索:通过ID获取特定文档。
  • 文档列表:列出指定书籍中的前100篇文章,支持按名称、类别等过滤和排序。
  • 书籍列表:列出组织中的前100本书籍,支持按名称过滤。
  • 类别列表:列出指定书籍中的前100个类别。
  • 文档搜索:通过关键词搜索文章,支持范围限定、分页和排序。

适用场景

  • 需要快速查找和访问Runbook平台上的文档内容。
  • 需要对大量文档进行分类和筛选。
  • 需要集成文档管理功能到其他应用程序中。

工具列表

  • get-article:通过ID获取特定文档。
  • list-articles:列出指定书籍中的文章,支持过滤和排序。
  • list-books:列出组织中的书籍,支持按名称过滤。
  • list-categories:列出指定书籍中的类别。
  • search-articles:通过关键词搜索文章,支持多种高级选项。

常见问题解答

  • 如何获取API令牌:需要在Runbook平台上生成并配置。
  • 如何配置服务器:通过修改claude_desktop_config.json或使用命令行参数。

使用教程

使用依赖

  • Node.js >= v20.0.0

安装教程

  1. 确保已安装Node.js v20.0.0或更高版本。
  2. 通过以下命令安装MCP服务器: bash npx -y @runbook-docs/mcp-server --api-token=your-api-token --base-url=https://yourdomain.runbook.jp

调试方式

  1. 确保环境变量RUNBOOK_BASE_URLRUNBOOK_API_TOKEN已正确设置。
  2. 运行服务器后,可以通过工具命令测试功能,例如: bash npx @runbook-docs/mcp-server get-article --articleUid=ar_123
  3. 检查日志输出以确认服务器运行状态和错误信息。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。