clouddocs

Name: clouddocs
Author: CloudCorpRecords

本地服务

github.com/CloudCorpRecords开发工具02 周前更新

代码仓库

关于 clouddocs

clouddocs 是用于搜索、阅读和获取相关页面推荐的 AWS 文档工具，提供 CLI 和 MCP 服务。它面向查阅公开 AWS 文档的开发者，无需 AWS 账户或 API 密钥，并限制读取和推荐的地址为 AWS 文档站点。

主要功能

01搜索官方 AWS 文档索引
02将文档页面转换为 Markdown 风格文本
03分段读取长页面
04推荐页面链接的相关文档
05限制读取地址为 AWS 文档站点

适用场景

01查找 AWS 服务的官方文档
02分段阅读较长的文档页面
03从文档页面查找相关资料

MCP 相关

stdio MCP 服务向客户端提供搜索文档、读取文档和推荐相关页面的工具。读取与推荐仅接受 AWS 文档站点地址。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "cloudcorprecords-clouddocs": {
      "command": "npx",
      "args": [
        "-y",
        "@reneturcios/clouddocs"
      ]
    }
  }
}

启动命令npx -y @reneturcios/clouddocs

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npm@reneturcios/clouddocs0.1.0stdio

ocighcr.io/cloudcorprecords/clouddocs:0.1.0stdio

工具

收录的工具列表 · 更新于 2 周前

参数	类型	必填	说明
limit	integer	否	要返回的搜索结果数上限（可选）；默认为 10。
search_phrase	string	是	用于搜索 AWS 文档的搜索短语。

详细介绍

clouddocs

clouddocs 是一个 AWS 文档阅览室。它会在 AWS 官方文档索引中搜索短语，打开文档页面并将其转换为整洁的 Markdown 风格文本，供你分段浏览；还会推荐页面指向的相关文档页面。它可通过命令行使用，也可作为供 Agent 使用的 MCP 服务；无需 AWS 账户或 API 密钥，因为它读取的内容全部来自公开文档网站。

仅接受 AWS 文档地址用于读取和推荐：docs.aws.amazon.com、aws.amazon.com 及其子域名。发出请求前会拒绝任何其他主机。

安装

npx @reneturcios/clouddocs search "s3 bucket naming"

或者运行容器镜像：

docker run -i ghcr.io/cloudcorprecords/clouddocs

容器默认启动 MCP 服务（见下文）。传入 CLI 参数即可将其用作 CLI。

CLI

# Search the documentation index
clouddocs search "s3 bucket naming rules"
clouddocs search "lambda execution role" --limit 5 --json

# Read a page as markdown-style text, optionally one window of it
clouddocs read https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
clouddocs read https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html --start-index 5000 --max-length 5000

# Related pages for a documentation page
clouddocs recommend https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html

clouddocs --version

退出码：成功时为 0；搜索或获取失败时为 1（错误信息会说明问题）；用法错误时为 2。

MCP 服务

同一个可执行文件支持两种用法。mcp 子命令会启动 stdio MCP 服务：

npx -y @reneturcios/clouddocs mcp

MCP 客户端配置：

{
  "mcpServers": {
    "clouddocs": {
      "command": "npx",
      "args": ["-y", "@reneturcios/clouddocs", "mcp"]
    }
  }
}

工具

工具	输入	返回内容
`search_documentation`	`search_phrase`（字符串，必填）、`limit`（整数，可选）	匹配的文档页面：每个页面的标题、URL 和简短摘要。搜索使用 `search.docs.aws.amazon.com` 上的官方搜索端点。
`read_documentation`	`url`（字符串，必填）、`max_length`（整数，可选）、`start_index`（整数，可选）	转换为 Markdown 风格文本的页面：保留标题、链接、列表和代码块，并移除导航内容和脚本。`start_index` 和 `max_length` 可选取转换后文本中的一个窗口，以便分段阅读较长页面。
`recommend`	`url`（字符串，必填）	与给定页面相关的 AWS 文档页面：该页面链接到的文档页面，按顺序排列并去重。

开发

npm install
npm run build   # tsc -> dist/
npm test        # node test runner over test/*.test.ts, no network (fake fetch fixtures)
npm run dev     # run the CLI from source via tsx