AI导哈

文档工具服务器

提供Read the Docs API工具和Vale lint工具的本地服务器，用于文档处理和语法检查。

  • by ericholscher
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 ericholscher/mcp

使用说明

MCP服务器：Read the Docs + Vale

此仓库提供了两个供本地使用的MCP服务器：

  • rtd_mcp.py阅读Read the Docs API工具和资源
  • vale_mcp.py使用本地 Vale CLI 运行 Vale 语言检查工具

要求

  • Python 3.11及以上版本
  • uv （推荐）或一个带有（所需功能/库的）Python环境 fastmcp 安装好的
  • Vale CLI 已安装并添加到您的 PATH 中（或已设置 VALE_PATH）

快速入门

使用uv运行：

# Read the Docs
uv run rtd_mcp.py

# Vale
uv run vale_mcp.py

或者直接使用Python：

python3 rtd_mcp.py
python3 vale_mcp.py

配置Claude桌面版

将示例MCP配置复制到您的Claude Desktop配置中，路径为：

  • macOS:（可翻译为）苹果操作系统 ~/Library/Application Support/Claude/claude_desktop_config.json

合并这个代码片段（根据需要调整路径）：

{
  "mcpServers": {
    "readthedocs": {
      "command": "uv",
      "args": ["run", "/Users/eric/projects/rtd-mcp/rtd_mcp.py"],
      "env": {
        "RTD_TOKEN": "<your_rtd_token_here>"
      }
    },
    "vale": {
      "command": "uv",
      "args": ["run", "/Users/eric/projects/rtd-mcp/vale_mcp.py"],
      "env": {
        "VALE_PATH": "/usr/local/bin/vale"
      }
    }
  }
}

重启 Claude 桌面应用以应用更改。

Vale MCP 工具

  • server_info() — 返回Vale CLI的版本/路径
  • list_styles(config_path?) — 列出可用的样式（考虑 --config （如果提供的话）
  • lint_text(text, styles?, min_alert_level?, ext?, config_path?) — 从标准输入（stdin）中 lint 文本，返回正常的 CLI 输出到 output
  • lint_file(path, styles?, min_alert_level?, config_path?) — 对文件进行检查，返回正常的CLI（命令行界面）输出 output
  • list_alert_levels() — 退货 ["suggestion","warning","error"]

默认值 .vale.ini 包括：

  • 微软 风格指南
  • 写得好 为了通俗易懂的语言
  • proselint（可译为“文章润色工具”或“文本校对工具”） 最佳实践

在Docker构建过程中，这些样式会自动同步。

注释：

  • 对于某些Vale版本， --styles 可能不受支持；建议通过您的方式设置样式 .vale.ini/.vale.yaml 并且通过 config_path 在需要时。
  • 我们通过 --no-exit 即使发现问题，也会返回结果。

部署到 fastmcp.cloud

这个仓库已配置为部署到 fastmcp.cloud 翻译为中文可以是“快速MCP云服务”或“FastMCP云平台”，具体翻译可能根据上下文和品牌定位有所调整。在这里，“MCP”可能代表某种特定的服务、平台或技术（如“云管理平台”等，具体需根据实际情况确定），“cloud”则明确表示这是与云计算或云服务相关的 支持Docker。

部署步骤

  1. 为这个仓库创建分支或将其导入到你的GitHub账户
  2. 将您的GitHub帐户连接到fastmcp.cloud
  3. 从fastmcp.cloud仪表板部署服务器
  4. 设置环境变量：
    • 对于 readthedocs设置 RTD_TOKEN 根据您的Read the Docs API令牌
    • 对于 valeVale 已预装在 Docker 镜像中，位于 /usr/local/bin/vale

这个（或“它”） fastmcp.yaml 配置文件定义了两台服务器，以及 Dockerfile 确保Vale在云环境中可用。

Docker 构建（本地测试）

要在本地测试 Docker 镜像：

docker build -t mcp-servers .
docker run -e RTD_TOKEN=your_token mcp-servers python rtd_mcp.py
docker run mcp-servers python vale_mcp.py

故障排除

  • 如果 fastmcp 导入失败，请安装它： uv add fastmcp 或者 pip install fastmcp。
  • 如果未找到Vale，请从https://vale.sh进行安装或设置 VALE_PATH 到二进制（文件/程序）。
  • 为了提高对标准输入（stdin）的规则覆盖率，请设置一个适当的 ext 像 .md 或者 .rst。

相关 MCP