文档搜索服务器

Zarf文档MCP服务器

一种模型上下文协议（MCP）服务器，提供对 扎夫 AI助手的文档。

扎夫是什么？

Zarf是一个免费的开源工具，用于声明性创建软件并将其分发到气隙、受限或独立环境中。它使团队能够以可重复、安全和可靠的方式打包和部署应用程序。

特性

此MCP服务器提供：

• 文档搜索：按关键字搜索所有Zarf文档
• 类别浏览：按类别浏览文档（CLI命令、参考、教程等）
• 快速入门指南：立即获得常见任务的帮助
• 架构参考：访问zarf.yaml配置架构
• 故障排除：获取常见问题的帮助

安装

# Clone the repository
git clone https://github.com/your-org/zarf-docs-mcp.git
cd zarf-docs-mcp

# Install dependencies
npm install

# Build
npm run build

用法

使用克劳德桌面

添加到您的Claude Desktop配置(~/.config/claude/claude_desktop_config.json 在Linux/macOS或 %APPDATA%\Claude\claude_desktop_config.json 在Windows上）：

{
  "mcpServers": {
    "zarf-docs": {
      "command": "node",
      "args": ["/path/to/zarf-docs-mcp/dist/index.js"]
    }
  }
}

使用克劳德代码

添加到您的Claude Code MCP设置中：

{
  "mcpServers": {
    "zarf-docs": {
      "command": "node",
      "args": ["/path/to/zarf-docs-mcp/dist/index.js"]
    }
  }
}

直接运行

npm start

可用工具

search_docs

在Zarf文档中搜索特定主题、命令或概念。

search_docs(query: "helm charts", limit: 5)

get_doc

获取特定文档部分的完整内容。

get_doc(id: "cli-init")

list_categories

列出所有可用的文档类别。

get_category

获取特定类别中的所有文档部分。

get_category(category: "CLI Commands")

list_docs

列出所有可用的文档部分及其ID。

get_quickstart

获取常见任务的快速入门指南。

get_quickstart(task: "create-package")

可用任务： install, create-package, deploy-package, init-cluster, publish-oci

get_schema

获取zarf.yaml模式信息。

get_schema(section: "components")

可用部分： metadata, components, variables, constants, full

可用资源

• zarf://overview -Zarf概述和介绍
• zarf://getting-started -入门指南
• zarf://faq -常见问题解答
• zarf://cli-reference -完整的CLI命令参考

可用提示

create-package

为新包生成zarf.yaml配置。

troubleshoot

获取帮助以排除常见的Zarf问题。

文件覆盖范围

服务器包括以下文档：

• 概述：什么是Zarf，主要功能，内置工具
• 入门指南：安装、快速启动、集群设置
• 参考：包、组件、操作、变量
• CLI命令：init、包创建/部署/删除/检查/发布/拉取、工具、开发
• 教程：创建包、Helm图表、OCI发布、差异包
• 最佳实践：气隙部署准则
• 示例：基本包、变量、操作
• 常见问题解答：常见问题和故障排除

发展

# Run in development mode
npm run dev

# Build
npm run build

# Type check
npx tsc --noEmit

许可证

麻省理工学院

链接

• Zarf文件
• Zarf GitHub
• 模型上下文协议