使用说明

• 项目简介

  • 这是一个可运行的 MCP 服务器实现，专门为 Dokploy 的文档提供支持。它把 API 参考、部署/设置指南、故障排除等文档以工具和资源的形式暴露给 MCP 客户端（如大语言模型代理），以便在不直接浏览网页的情况下获取准确的文档信息。

• 主要功能点

  • 提供三类工具：
    • dokploy_api_reference：获取 Dokploy REST API 的完整参考，支持全部类别或指定类别分段获取
    • dokploy_guide：获取指定的指南（如 deploy、setup、auto-deploy、troubleshooting 等）
    • dokploy_search：按关键词在文档中进行全文检索并返回包含上下文的结果
  • 提供三种资源视图：
    • Dokploy API Reference（API 参考文档）
    • Auto-Deploy Guide（自动部署指南）
    • Troubleshooting Guide（故障排除指南）
  • 通过本地文档（docs 目录）提供离线缓存的文档内容，方便快速检索和读取。

• 安装步骤

  • 将仓库中的 mcp-server 目录作为 MCP 服务器运行环境：
    • 进入 mcp-server 目录
    • 安装依赖：在该目录执行 npm install
  • 获取并准备文档：
    • 本仓库提供了本地 docs（docs 目录）和一个脚本 fetch-docs.js，用于从 Context7 拉取最新文档并写入 docs 目录（需要网络访问）
  • 启动服务器：
    • 在 mcp-server 目录内，直接运行 index.js（使用 Node.js）以启动 MCP 服务器
    • 服务器使用标准输入输出（stdio）作为传输通道，适合与 MCP 客户端通过流式传输进行通信

• 服务器配置（MCP 客户端需要的启动信息，配置为 JSON，供参考；实际客户端不需要你粘贴这段代码）

  • 配置示例（JSON），用于 MCP 客户端连接此服务器 { "server": "dokploy-docs", "command": "node", "args": ["<full-path-to>/mcp-server/index.js"] } 注：上述配置中的 <full-path-to> 需要替换为实际的使用环境中的绝对路径；该配置用于 MCP 客户端在初始化阶段启动并连接到 MCP 服务器。客户端本身不需要包含应用逻辑，服务器端负责提供工具与资源。

• 基本使用方法

  • 启动后，MCP 客户端可以通过以下方式与服务器交互：
    • 列出可用工具（dokploy_api_reference、dokploy_guide、dokploy_search）
    • 调用工具获取相应的文档内容（API 参考、指南、搜索结果）
    • 读取资源中的文档（如 API 参考、指南等的全文）
  • 客户端会接收 MCP 服务器按请求返回的 JSON-RPC 响应，包含文本内容、上下文等信息，供 LLM 使用或直接展示给开发者。

• 备注

  • 本 MCP 服务器依赖于 @modelcontextprotocol/sdk，具体实现通过 stdio 传输和基于 Markdown 文档的读取与搜索来提供内容。
  • 文档内容来源于 docs 目录，如 api-reference.md、deploy-guide.md、setup-guide.md 等，若某些文档缺失，将回退到内置的参考内容。