Ative
O instalador com Docker Compose deixa o endpoint desligado por padrão. Adicione o seguinte ao.env no diretório kodus-installer:
docker compose up -d --no-deps api nesse diretório para aplicar a variável.
O chart Helm habilita o endpoint por padrão. Para desligá-lo, defina global.config.API_MCP_SERVER_ENABLED como "false" no arquivo de valores e rode helm upgrade.
Enquanto estiver desativado, a API não serve /mcp. A rota é POST /mcp no host da API, então um reverse proxy precisa encaminhá-la. Veja Reverse Proxy.
Conecte um cliente
Conecte o cliente ahttps://<your-api-host>/mcp na API da sua instância. O servidor usa Streamable HTTP.
- Abra Organization → CLI keys, gere uma chave e copie-a. Apenas os owners da organização podem gerar chaves. Veja CLI keys.
- Configure o cliente para enviar a chave em um destes cabeçalhos ao chamar uma ferramenta.
kodus-api.example.com pelo host da sua API e liste as ferramentas. Essa consulta funciona sem chave.
- Uma chave pertence a um time. Um argumento
teamIdde outro time é rejeitado, e umteamIdomitido é preenchido a partir da chave. - A maioria das ferramentas recebe um argumento
organizationId. Ele precisa ser o ID da sua organização. Qualquer outro valor é rejeitado. initialize,tools/listepingfuncionam sem chave. Qualquer outra chamada exige uma chave válida, e uma chave ausente, inválida ou revogada retorna401.
Ferramentas
Repositórios e pull requests
Kody Issues
Kody Rules e memórias
Gerenciando regras e memórias
KODUS_CREATE_KODY_RULE, KODUS_UPDATE_KODY_RULE, KODUS_DELETE_KODY_RULE e KODUS_CREATE_MEMORY exigem a capability kodyRules:manage na chave. Em Organization → CLI keys, clique em Configure na chave e ative Allow Kody Rules management via CLI. Sem isso, essas ferramentas retornam um resultado de erro (isError: true) dizendo que a chave não tem permissão para gerenciar Kody Rules. As demais ferramentas não exigem nenhuma capability.
- Uma regra criada pelo servidor mostra a origem MCP/Agent e fica em Pending review até alguém aprová-la.
- Uma memória só fica lá quando Kody knowledge approval está ativado.
- Com uma configuração centralizada ativada, criar, alterar ou excluir uma regra ou memória abre um pull request no repositório de configuração.
Limites
- Apenas
POSTé suportado. - Stateless. O servidor não mantém sessão entre requisições e não retorna
Mcp-Session-Id. - Ele não envia nada ao cliente fora da resposta a um
POST.