Clix MCP Server

Clix MCP Server 允许AI代理提供实时、可靠的Clix文档和SDK代码示例，以实现与任何兼容MCP客户端的无缝集成。

Clix MCP Server 实现了 Model Context Protocol (MCP)，这是一个开放标准，用于使LLMs能够与外部工具和数据进行交互。

关键功能：

• 文档搜索 — 搜索Clix文档（用户指南、API参考、故障排除、最佳实践），并使用语义排名。
• SDK搜索 — 探索Clix SDKs（iOS、Android、Flutter、React Native）及其实施示例。发现SDK符号并检索生产就绪的代码片段。

安装

预备条件

• Node.js >= 18

快速开始

安装Clix MCP Server：

npm i -g @clix-so/clix-mcp-server@latest

在项目根目录下创建或更新 .mcp.json 文件（或您的MCP客户端使用的配置位置）。使用 npx 可确保始终运行最新发布的版本：

共享MCP配置

添加Clix：

{
  "mcpServers": {
    "clix-mcp-server": {
      "command": "npx",
      "args": ["-y", "@clix-so/clix-mcp-server@latest"]
    }
  }
}

将此内容放置在您的客户端MCP配置中（例如，VS Code扩展设置、~/.cursor/mcp.json 或您的Copilot客户端的MCP设置）。

Claude Code配置

打开终端以访问Claude Code CLI。运行以下命令以注册Clix MCP Server。

claude mcp add --transport stdio clix-mcp-server -- npx -y @clix-so/clix-mcp-server@latest

Codex配置

打开 ~/.codex/config.toml。添加以下配置并重启Codex CLI：

[mcp_servers]
  [mcp_servers.clix]
  command = "npx"
  args = ["-y", "@clix-so/clix-mcp-server@latest"]

重启您的MCP客户端以加载配置。

命令行选项

clix-mcp-server [选项]

--version, -v  显示版本
--help, -h     显示帮助

使用方法

此包作为MCP服务器运行。一旦在您的MCP客户端中配置好，您就可以从客户端的工具面板或助手UI直接调用 search_docs 和 search_sdk。

注意事项：

• 需要网络访问才能获取文档页面和SDK源文件。
• 默认超时时间和结果数量可以通过环境变量调整：
  • DOCS_SEARCH_MAX_RESULTS（默认：3）
  • SDK_SEARCH_MAX_RESULTS（默认：3）

本地开发

本地设置

# 克隆并安装
git clone https://github.com/clix-so/clix-mcp-server.git
cd clix-mcp-server
npm install

# 构建
npm run build

# 运行测试
npm test

# 开发模式（监视更改）
npm run dev

本地开发的MCP客户端配置

在包发布之前，配置您的MCP客户端以使用本地构建：

{
  "mcpServers": {
    "clix": {
      "command": "node",
      "args": ["/绝对路径/to/clix-mcp-server/dist/index.js"]
    }
  }
}

将 /绝对路径/to/clix-mcp-server 替换为您实际的项目路径。

贡献

欢迎贡献！请阅读我们的指南 CONTRIBUTING.md，并在提交PR前打开一个问题来讨论重大变更。

支持

如果您遇到问题或有功能请求，请在GitHub上打开一个问题。对于使用问题，请查阅工具返回的文档和示例。

许可证

MIT许可证，带有自定义限制 - 详情见 LICENSE。

资源

• 文档
• GitHub问题
• Clix仪表板