Docs

Consulte o voar pelo seu app de IA

Veja o saldo, os últimos jobs e o consumo da sua organização sem sair da conversa. O MCP é a conexão que permite ao seu app de IA consultar o voar. O acesso é somente leitura: ele não inicia jobs nem muda configurações.

Conecte seu app

Você precisa ser owner ou admin de uma organização do GitHub com o voar instalado. Em um app que aceite servidores MCP remotos com OAuth, adicione este endereço:

https://api.voar.dev/mcp

O transporte é Streamable HTTP: a conexão vai pela internet, sem instalar um servidor local do voar.

Quando o app abrir o voar, entre na sua conta, escolha a organização e aprove. Cada conexão recebe uma chave própria, somente leitura. Não cole chaves ou senhas na conversa.

Depois de conectar, peça:

Mostre os últimos 5 jobs da minha organização e diga se algum não conseguiu começar.

O app pode consultar os jobs e explicar o status, o custo e o motivo informado quando uma máquina não iniciou. Ele não lê os logs do job.

O que você pode consultar

  • get_account: saldo, unidades grátis do mês, máquinas ativas e jobs na fila. Permissão: account:read.
  • list_jobs: jobs recentes, com status, conclusão, máquina, horários, custo e motivo caso não tenham iniciado. Aceita limit de 1 a 100 e before em ISO 8601. Permissão: jobs:read.
  • get_usage: consumo e custo dos jobs concluídos, dia a dia. Aceita month como AAAA-MM; sem ele, usa o mês atual em America/Sao_Paulo. Permissão: usage:read.

Permissões e como desconectar

A conexão lê apenas a organização escolhida. Não inicia nem cancela jobs, não compra crédito e não altera limites. Não recebe código-fonte, logs de execução, secrets de workflow ou dados de cartão.

Para cortar o acesso, abra a organização no painel, vá em Configurações e revogue a chave do app. Desconectar só no app de IA pode deixar a chave ativa. Ela também para de funcionar se quem autorizou sair da organização ou deixar de ser owner ou admin.

Abrir o painel

Ver como os apps de IA usam os dados

Para programadores

Use o endpoint acima com um cliente MCP que aceite OAuth 2.1 com PKCE. Um cliente que aceite cabeçalho Bearer também pode usar uma chave criada nas Configurações da organização. A API REST usa as mesmas permissões e os mesmos dados.

Para testar a API REST, crie uma chave com account:read, guarde-a em VOAR_API_KEY e consulte o resumo da organização:

curl https://api.voar.dev/v1/account \  -H "Authorization: Bearer $VOAR_API_KEY"

Abrir a especificação OpenAPI

Uma unidade é um minuto na máquina de 2 vCPU. Máquinas maiores contam mais unidades por minuto. Campos terminados em Micros usam milionésimos da moeda informada por get_account.

Agentes sem navegador local podem usar o login por código com client_id=voar-agent. Inicie em /oauth/device_authorization, abra o verification_uri recebido, aprove o código e consulte /oauth/token no intervalo indicado.

Se a conexão não funcionar

  • Se o app pedir login de novo ou responder 401, a chave deixou de valer: foi revogada, o app do GitHub saiu da organização ou quem a aprovou deixou de ser owner ou admin. Conecte de novo com uma conta owner ou admin. Uma chave revogada não volta a funcionar.
  • Se receber 403, a chave foi criada sem a permissão que a ferramenta pede. Nas Configurações, crie outra chave com a permissão que falta.
  • Se não der para autorizar outra conexão, revogue uma chave que não usa nas Configurações e tente de novo. A lista inclui as chaves criadas por apps de IA.
  • Se receber 429, espere o tempo indicado em Retry-After antes de tentar de novo. As chaves da mesma organização compartilham o limite.
  • Se o seu app não aceitar um servidor remoto com OAuth, use um cliente MCP que aceite ou acesse a API REST com uma chave.