项目简介
GroundDocs 是一个基于 Model Context Protocol (MCP) 的本地服务器实现,专门用于连接大型语言模型 (LLM) 到可信、实时的 Kubernetes 文档。它能帮助 LLM 获得特定版本的 Kubernetes 文档内容,从而在回答相关问题时提供准确、版本匹配的信息,显著减少“幻觉”或过时信息的出现。
主要功能点
- 提供Kubernetes文档检索工具: 向连接的LLM客户端注册一个工具,允许LLM通过自然语言查询获取特定版本Kubernetes的官方文档片段。
- 支持版本感知: 能够根据LLM请求中指定的版本检索相应的文档,确保信息的时效性和准确性。
- 集成现有工作流: 设计为可被支持MCP协议的LLM客户端(如某些IDE或聊天客户端)调用,无缝融入开发者的工作环境。
- 本地运行: 作为本地服务运行,与远程后端协作处理复杂的文档索引和检索任务。
安装步骤
要安装 GroundDocs,您通常可以使用其提供的命令行工具。打开您的终端或命令行界面,运行以下命令:
npx @grounddocs/cli@latest install <client>
将 '<client>' 替换为您正在使用的支持 MCP 协议的 LLM 客户端名称。支持的客户端可能包括 cursor、windsurf 等(请查阅 GroundDocs 最新文档获取完整列表)。这个命令会自动处理下载和设置。
服务器配置
安装完成后,您需要在您的 MCP 客户端(例如支持 MCP 的 IDE 或其他应用)中配置 GroundDocs 服务器。配置方式通常涉及编辑客户端的 MCP 配置文件,添加一个新的 MCP 服务器条目。
配置信息是一个 JSON 对象,您需要指定 GroundDocs 服务器的启动方式。基本的配置会告诉客户端如何启动 GroundDocs 进程,以便建立通信。
以下是配置中可能需要包含的关键信息示例(请参考您的 MCP 客户端的具体配置格式进行调整):
- 服务器名称 ('name'): 一个标识服务器的唯一名称,例如 '"@grounddocs/grounddocs"'。
- 命令 ('command'): 启动服务器进程的命令,例如 '"npx"'。
- 参数 ('args'): 传递给启动命令的参数列表,例如 '["-y", "@grounddocs/grounddocs@latest"]'。这些参数会告诉 'npx' 执行 GroundDocs 的最新版本。
配置完成后,通常需要重启您的 MCP 客户端以加载新的服务器配置。
基本使用方法
一旦 GroundDocs MCP 服务器在您的 MCP 客户端中配置并运行,LLM 客户端将能够通过 MCP 协议自动发现并调用 GroundDocs 提供的工具。
当您在支持的客户端中提出与 Kubernetes 文档相关的问题时,LLM 可以利用 GroundDocs 工具来检索准确、版本相关的官方信息,并基于这些信息生成回答。
例如,您可以尝试提出一个关于特定 Kubernetes 版本功能的问题:
What changes were made to the kubectl command behavior in Kubernetes 1.26 regarding pruning during apply operations?
LLM 客户端可能会调用 GroundDocs 工具来查找 Kubernetes 1.26 版本关于 'kubectl apply --prune' 的文档,然后利用找到的信息来回答您的问题。
信息
分类
开发者工具