Clix MCP Server

Servidor MCP Clix para auxiliar integrações com o SDK/API Clix, com busca semântica na documentação e no código-fonte do SDK (iOS, Android, Flutter, React Native).

Documentação

Clix MCP Server

npm version npm downloads License

O Clix MCP Server permite que agentes de IA entreguem documentação do Clix em tempo real e confiável, além de exemplos de código do SDK para integrações perfeitas diretamente em qualquer cliente compatível com MCP.

O Clix MCP Server implementa o Model Context Protocol (MCP), um padrão aberto que permite que LLMs interajam com ferramentas e dados externos.

Principais recursos:

  • Busca na Documentação — Pesquise na documentação do Clix (guias do usuário, referência da API, solução de problemas, melhores práticas) com classificação semântica.
  • Busca no SDK — Explore os SDKs do Clix (iOS, Android, Flutter, React Native) e exemplos de implementação. Descubra símbolos do SDK e obtenha trechos prontos para produção.

Instalação

Pré-requisitos

  • Node.js >= 18

Início Rápido

Instale o Clix MCP Server:

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

Crie ou atualize o .mcp.json na raiz do seu projeto (ou no local de configuração que seu cliente MCP utiliza). Usar npx garante que você sempre execute a versão publicada mais recente:

Configuração MCP compartilhada

Adicione o Clix com:

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

Coloque isso na configuração MCP do seu cliente (por exemplo, configurações da extensão do VS Code, ~/.cursor/mcp.json, ou as configurações MCP do seu cliente Copilot).

Configuração do Claude Code

Abra o terminal para acessar a CLI do Claude Code. Execute o seguinte comando para registrar o Clix MCP Server.

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

Configuração do Codex

Abra o ~/.codex/config.toml. Adicione a seguinte configuração e reinicie a CLI do Codex:

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

Reinicie seu cliente MCP para carregar a configuração.

Opções de Linha de Comando

clix-mcp-server [options]

--version, -v  Show version
--help, -h     Show help

Uso

Este pacote executa como um servidor MCP. Uma vez configurado no seu cliente MCP, você pode invocar search_docs e search_sdk diretamente da paleta de ferramentas do cliente ou da interface do assistente.

Observações:

  • É necessário acesso à rede para buscar páginas de documentação e arquivos de código-fonte do SDK.
  • Os tempos limite padrão e as contagens de resultados podem ser ajustados por meio de variáveis de ambiente:
    • DOCS_SEARCH_MAX_RESULTS (padrão: 3)
    • SDK_SEARCH_MAX_RESULTS (padrão: 3)

Desenvolvimento Local

Configuração Local

# 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

Configuração do Cliente MCP para Desenvolvimento Local

Antes de o pacote ser publicado, configure seu cliente MCP para usar a versão local:

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

Substitua /absolute/path/to/clix-mcp-server pelo caminho real do seu projeto.

Contribuindo

Contribuições são bem-vindas! Leia nossas diretrizes em CONTRIBUTING.md e abra uma issue para discutir mudanças significativas antes de enviar um PR.

Suporte

Se você encontrar problemas ou tiver solicitações de recursos, abra uma issue no GitHub. Para dúvidas de uso, consulte a documentação e os exemplos retornados pelas ferramentas.

Licença

Licença MIT com Restrições Personalizadas — consulte LICENSE para detalhes.

Recursos