AI导哈

Outline文档搜索服务

Outline MCP是一个模型控制协议服务器，用于集成Outline知识库与Claude，提供文档搜索和检索功能，帮助Claude利用组织内部文档回答问题。

  • by ChrisL108
  • Python
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 chrisl108/outline-mcp

使用说明

MCP概述

用于将Outline与Claude集成的MCP（模型控制协议）服务器。

概述

此工具使Claude能够从大纲知识库中搜索和检索文档。使用它来帮助Claude使用您组织的内部文档回答问题。

特性

  • 在Outline实例中搜索文档
  • 按ID检索完整文档内容
  • 在会话之间维护持久凭据

安装

备注：您的大纲API密钥必须具有以下权限：

  • documents.info -用于检索文档内容
  • documents.search -用于搜索文档

备注：如果 OUTLINE_URL 和 OUTLINE_API_KEY 如果您的配置中没有提供，Claude将提示您提供它们。这些凭据将保存在 ~/.outline_mcp_credentials.json 以备将来使用。

选项1：通过Smithery CLI安装（需要Smithery密钥）

npx -y @smithery/cli@latest install @ChrisL108/outline-mcp --client claude --key your-smithery-api-key

您可以输入您的 OUTLINE_URL 和 OUTLINE_API_KEY 当克劳德提示或将其添加到您的 claude_desktop_config.json 直接：

"env": {
    "OUTLINE_URL": "https://your.outline.com",
    "OUTLINE_API_KEY": "your-outline-api-key"
}

您的配置应该如下所示：

"outline-mcp": {
    "command": "npx",
    "args": [
      "-y",
      "@smithery/cli@latest",
      "run",
      "@ChrisL108/outline-mcp",
      "--key",
      "your-smithery-api-key"
    ],
    "env": {
      "OUTLINE_URL": "https://your.outline.com",
      "OUTLINE_API_KEY": "your-outline-api-key"
    }
}

选项2：通过UVX安装

"outline-mcp": {
    "command": "uvx",
    "args": [
      "--from",
      "git+https://github.com/ChrisL108/outline-mcp",
      "outline-mcp"
    ],
    "env": {
      "OUTLINE_URL": "https://your.outline.com",
      "OUTLINE_API_KEY": "your-outline-api-key"
    }
}

用法

安装后，您可以在与Claude的对话中使用以下功能：

搜索文档

search_documents(query, outline_url=None, api_key=None, limit=5, status_filter="published", date_filter="year")

参数：

  • query：搜索词（必填）
  • outline_url：Outline实例的基本URL（仅第一次需要）
  • api_key：概述API密钥（仅第一次需要）
  • limit：最大结果数（默认值：5）
  • status_filter：按状态筛选（默认：“已发布”）
  • date_filter：按日期筛选（默认值：“年份”）

按ID获取文档

get_document_by_id(document_id)

参数：

  • document_id：要检索的文档的ID（必需）

更新凭据

update_credentials(outline_url, api_key)

参数：

  • outline_url：Outline实例的基本URL
  • api_key：概述API密钥

拼

ping()

验证MCP服务器是否正常工作的简单测试功能。

示例提示

以下是一些可以与Claude一起使用的示例提示：

  1. “搜索大纲以获取有关我们产品路线图的信息。”
  2. “你能找到任何与我们的招聘流程相关的文件吗？”
  3. “请查看我们的AWS设置内部文档。”
  4. “您能获取此文档的全部内容吗？[document_id]”

故障排除

如果您遇到问题：

  1. 确保您的大纲URL和API密钥配置正确
  2. 验证您的Outline实例是否可访问
  3. 检查您的API密钥是否具有必要的权限
  4. 试试 ping() 验证MCP服务器是否正常运行的功能

安全考虑

  • 确保API密钥的安全，不要共享
  • MCP服务器仅具有授予您的API密钥的权限
  • 如果您只需要搜索功能，请考虑使用只读API密钥

许可证

MIT许可证

版权所有（c）2025 ChrisL108

特此免费向任何获得副本的人授予许可 本软件和相关文档文件（“软件”），以处理 在软件中不受限制，包括但不限于权利 使用、复制、修改、合并、发布、分发、再许可和/或销售 软件的副本，并允许软件的接收者 根据以下条件提供：

上述版权声明和本许可声明应包含在所有 软件的副本或实质性部分。

软件按“原样”提供，不提供任何形式的明示或明示担保 隐含的，包括但不限于适销性保证， 适用于特定目的且不造成伤害。在任何情况下 作者或版权持有人对任何索赔、损害赔偿或其他 因以下原因产生的责任，无论是在合同、侵权或其他诉讼中， 出于或与软件、使用或其他交易有关 软件。

贡献

欢迎投稿！请随时提交拉取请求。

鸣谢

由...创建 克里斯L108

相关 MCP