Documentation Index
Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt
Use this file to discover all available pages before exploring further.
Resumo: o MCP da GYRA+ é hospedado pela GYRA+ em
https://mcp.gyramais.com.br. Você só configura o cliente (Claude.ai, Claude Desktop, Cursor, etc.) e autentica com as credenciais (clientId + clientSecret) enviadas pelo suporte. Existem duas formas de conectar: custom connector (OAuth), indicado para Claude.ai e Claude Desktop, e stdio local, indicado para Claude Code, Cursor, VS Code e SDKs próprios.Obter credenciais
As credenciais do MCP são as mesmas credenciais de API da sua organização:clientId e clientSecret. Não existe tela no toolbox para gerá-las. Solicite por e-mail:
clientId e clientSecret. Guarde em cofre seguro (1Password, Vault, etc.) — elas dão acesso a todas as tools do MCP e endpoints da API REST.
Endpoint do servidor
Opção 1, Custom connector no Claude.ai ou Claude Desktop (recomendado)
Fluxo via OAuth: você adiciona o endpoint uma única vez, clica em Autenticar e a GYRA+ abre uma página de login onde você informa oclientId e clientSecret recebidos do suporte. O Claude volta conectado.
Abrir a tela de connectors
- Claude.ai: Settings > Connectors > Add custom connector.
- Claude Desktop: Settings > Connectors > Add custom connector.
Autenticar
Clicar em Authenticate ao lado do connector recém-adicionado. O Claude abre uma aba no navegador com a página de login da GYRA+.
Informar clientId e clientSecret
Na página de login da GYRA+, cole as credenciais recebidas do suporte:
- Client ID
- Client Secret
Opção 2, Stdio local (Claude Code, Cursor, VS Code, SDKs)
Para clientes que rodam o MCP como processo local via stdio, use o pacote@gyramais/mcp-server (binário gyra-mcp) e passe as credenciais como variáveis de ambiente.
Variáveis de ambiente
| Variável | Obrigatório | Descrição |
|---|---|---|
GYRA_CLIENT_ID | Sim (ou GYRA_ACCESS_TOKEN) | Client ID recebido do suporte. |
GYRA_CLIENT_SECRET | Sim (ou GYRA_ACCESS_TOKEN) | Client Secret recebido do suporte. O MCP troca por um JWT automaticamente e renova antes de expirar. |
GYRA_ACCESS_TOKEN | Alternativa | JWT obtido manualmente via POST /auth/authenticate. Estático, você é responsável por renovar. |
GYRA_BASE_URL | Não | Default https://gyra-core.gyramais.com.br. |
GYRA_PROFILE | Não | external (default) ou internal. Use external para uso normal. |
GYRA_CLIENT_ID + GYRA_CLIENT_SECRET (recomendado, com renovação automática) ou GYRA_ACCESS_TOKEN (estático).
Claude Code (CLI)
Cursor
Add new MCP server
- Name:
gyra - Type:
command - Command:
npx -y @gyramais/mcp-server - Env:
GYRA_CLIENT_ID=seu_client_idGYRA_CLIENT_SECRET=seu_client_secret
Claude Desktop, config manual via stdio
Se preferir configurar via arquivo em vez de usar o custom connector:- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
VS Code via Continue
~/.continue/config.json:
Cliente customizado (SDK)
Python:Verificação rápida
Depois de conectar, no cliente MCP:- Pergunte: “quais tools da gyra estão disponíveis?” — deve listar
create_report,list_reports,list_policies, etc. - Pergunte: “quais políticas tenho ativas?” — deve chamar
list_policiese retornar a lista.
Segurança das credenciais
- Nunca commitar config com
clientSecretem repositório. - Em configs JSON, referenciar via variáveis de ambiente do sistema (
${env:GYRA_CLIENT_SECRET}) quando o cliente suportar. - Em caso de vazamento, acione
atendimento@gyramais.compara reemissão — a credencial antiga é invalidada. - No fluxo OAuth (Opção 1), as credenciais ficam armazenadas de forma segura no cliente (Claude) e o MCP recebe apenas um token de sessão revogável.
Perguntas frequentes
Posso usar a Opção 1 (custom connector) no Cursor ou Claude Code?
Posso usar a Opção 1 (custom connector) no Cursor ou Claude Code?
Hoje o custom connector com OAuth é suportado no Claude.ai e Claude Desktop. Cursor, Claude Code e VS Code usam configuração stdio local (Opção 2).
Preciso instalar algo além do cliente?
Preciso instalar algo além do cliente?
Para a Opção 2,
npx @gyramais/mcp-server é baixado on demand. Se o ambiente não tem npm, instale Node.js 18+.Funciona offline?
Funciona offline?
Não. O MCP depende do backend da GYRA+, exige internet.
Posso conectar múltiplas organizações?
Posso conectar múltiplas organizações?
Sim. Para stdio, adicione várias entradas em
mcpServers com nomes distintos (ex: gyra-orgA, gyra-orgB) e credenciais específicas. Para custom connector, adicione múltiplos connectors no Claude, cada um com suas credenciais.Como renovar o token manualmente?
Como renovar o token manualmente?
Se estiver usando
GYRA_ACCESS_TOKEN, chame POST /auth/authenticate com headers gyra-client-id e gyra-client-secret e use o accessToken retornado. Usando GYRA_CLIENT_ID + GYRA_CLIENT_SECRET o MCP faz isso automaticamente.Próximos passos
Ferramentas disponíveis
Catálogo completo de tools.
Casos de uso
Exemplos de conversas úteis.
Troubleshooting
Problemas comuns na instalação.
API Keys e webhooks
Uso das credenciais na API REST.

