OCI文档搜索工具

OCI文档MCP服务器提供搜索和访问OCI文档的工具,适用于开发者和技术文档分析师。

  • by jin38324
  • Python
  • 混合部署
  • 12 星标
  • 更新于
在 GitHub 查看 jin38324/oci-documentation-mcp-server

使用说明

灵感来源:https://github.com/awslabs/mcp/tree/main/src/aws-documentation-mcp-server

OCI文档MCP服务器

OCI文档的模型上下文协议(MCP)服务器

此MCP服务器提供搜索内容和访问OCI文档的工具。

更新日志

  • 2026-05-20:支持传输:标准传输、标准传输、可流式传输http
  • 2026-05-19:将搜索引擎改为oracle帮助中心搜索
  • 2025-04-21:首次发布

特性

oci_search_documentation

通过Oracle帮助中心搜索API搜索OCI文档并返回 结构化页面结果。此工具用于文档的第一步 工作流:在阅读页面之前找到最相关的Oracle文档URL。

参数:

  • search_phrase:搜索文本。使用特定的OCI服务名称、产品术语、错误 以获得更好的结果。
  • limit:要返回的最大结果数。默认为 3.
  • page:搜索结果页码。默认为 1.

退货:

  • Oracle帮助中心结果集中的分页元数据。
  • 包含标题、URL和描述的文档结果列表。

设计说明:

  • 使用公共Oracle帮助中心页面终结点。

oci_read_documentation

读取一个OCI文档页面,将其从HTML转换为Markdown,并按以下方式对其进行索引 行号,并返回一个内容窗口。此工具用于受控 在不淹没MCP响应的情况下阅读长文档页面。

参数:

  • url:OCI文档页面URL。该URL必须来自 docs.oracle.com 并且必须 以...结束 .htm 或 .html.
  • start_index:从0开始读取的行号。默认为 0.
  • max_lines:返回的最大Markdown行数。默认为 10.

退货:

  • stats:总行数、总单词数、起始行数、返回行数、剩余行数和 剩下的话。
  • content:请求的行窗口的Markdown文本。
  • table_of_contents:仅在以下情况下返回 start_index == 0;包括航向水平, 标题和从0开始的行号。

设计说明:

  • 长文档按Markdown行号分页,而不是按字符偏移量分页 使代理人更容易进行后续阅读。
  • 转换后的页面在进程内存中缓存24小时,最多128页。缓存 存储单行列表表示,以避免复制完整的Markdown文本和 分割线。
  • 目录和相关链接仅在首次阅读时返回,以避免 在后续读取过程中重复元数据。

使用

选项1:从pypi包运行

通过Defalt输出 stdio,更改该用法 --transport 如果你愿意。

{
  "mcpServers": {
    "oci-documentation-mcp-server": {
      "command": "uvx",
      "args": [
        "--from",
        "oci-documentation-mcp-server@latest",
        "python",
        "-m",
        "oci_documentation_mcp_server.server",
        "--transport",
        "stdio"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR"
      }
    }
  }
}

选项2:从源代码本地运行,并通过stdio输出

安装要求

  1. 不要加载此仓库。 2.安装 uv 从 星体 或 GitHub自述
{
  "mcpServers": {
    "oci-documentation-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/oci-documentation-mcp-server"
        "run",
        "python",
        "-m",
        "oci_documentation_mcp_server.server",
        "--transport",
        "stdio"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR"
      }
    }
  }
}

选项3:作为服务器运行

以服务器使用方式运行 Streamable HTTP:

uv run python -m oci_documentation_mcp_server.server --transport "streamable-http" --port 8000 --path "/mcp"

代理工具上的配置:

{
  "mcpServers": {
      "oci-documentation-mcp-server": {
      "type": "streamable-http",
      "url": "http://localhost:8000/mcp"
    }
  }
}