使用说明
Clix MCP服务器
Clix MCP Server使AI代理能够提供实时、可信赖的Clix 文档和SDK代码示例，用于在任何 MCP兼容客户端。
Clix MCP服务器实现了 模型上下文协议（MCP），一个开放 使LLM能够与外部工具和数据交互的标准。
关键能力：
- 文档搜索 -搜索Clix文档（用户指南，API参考， 故障排除、最佳实践）与语义排名。
- SDK搜索 --探索Clix SDK（iOS、Android、Flutter、React Native）和 实施示例。发现SDK符号并检索生产就绪 片段。
安装
先决条件
- Node.js>=18
快速开始
安装Clix MCP服务器：
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代码配置
打开终端以访问Claude Code CLI。运行以下命令 注册Clix MCP服务器。
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 [options]
--version, -v Show version
--help, -h Show help
用法
此包作为MCP服务器运行。在MCP客户端中配置后，您可以
调用 search_docs 和 search_sdk 直接从客户的工具面板或
辅助UI。
笔记：
- 需要网络访问才能获取文档页面和SDK源文件。
- 默认超时和结果计数可以通过环境变量进行调整：
DOCS_SEARCH_MAX_RESULTS（默认值：3）SDK_SEARCH_MAX_RESULTS（默认值：3）
本地开发
本地设置
# Clone and install
git clone https://github.com/clix-so/clix-mcp-server.git
cd clix-mcp-server
npm install
# Build
npm run build
# Run tests
npm test
# Development mode (watch for changes)
npm run dev
本地开发的MCP客户端配置
在发布包之前，配置您的MCP客户端以使用本地 构建：
{
"mcpServers": {
"clix": {
"command": "node",
"args": ["/absolute/path/to/clix-mcp-server/dist/index.js"]
}
}
}
替换 /absolute/path/to/clix-mcp-server 根据您的实际项目路径。
贡献
欢迎投稿！请阅读我们的指南 贡献.md 并提出一个重要问题进行讨论 在提交PR之前进行更改。
支持
如果您遇到问题或有功能请求，请在上打开问题 github。有关使用问题，请查看工具返回的文档和示例。
许可证
带有自定义限制的MIT许可证-请参阅 许可证 了解详情。
