Docs

Check voar from your AI app

Read your organization's balance, recent jobs and usage without leaving the conversation. MCP lets your AI app query voar. Access is read-only: it cannot start jobs or change settings.

Connect your app

You need to be an owner or admin of a GitHub organization with voar installed. In an app that supports remote MCP servers with OAuth, add this address:

https://api.voar.dev/mcp

The transport is Streamable HTTP: the connection runs over the internet, with no local voar server to install.

When the app opens voar, sign in, choose your organization and approve access. Each connection gets its own read-only key. Keep keys and passwords out of the conversation.

Once connected, ask:

Show my organization's last 5 jobs and tell me if any could not start.

The app can read the jobs and explain their status, cost and the reported reason a machine did not start. It cannot read job logs.

What you can read

  • get_account: balance, monthly free units, active machines and queued jobs. Requires account:read.
  • list_jobs: recent jobs with status, conclusion, machine size, timestamps, cost and any reason they did not start. Accepts limit from 1 to 100 and before in ISO 8601. Requires jobs:read.
  • get_usage: daily usage and cost for finished jobs. Accepts month as YYYY-MM; defaults to the current month in America/Sao_Paulo. Requires usage:read.

Access and disconnecting

The connection reads only the organization you chose. It cannot start or cancel jobs, buy credit or change limits. It receives no source code, execution logs, workflow secrets or card details.

To cut off access, open your organization in the dashboard, go to Settings and revoke the app's key. Disconnecting only in the AI app may leave the key active. It also stops working if the person who approved it leaves the organization or loses their owner or admin role.

Open the dashboard

Read how connected AI apps use your data

For programmers

Use the endpoint above with an MCP client that supports OAuth 2.1 with PKCE. Clients that support a Bearer header can also use a key created in the organization's Settings. The REST API shares the same permissions and data.

To try the REST API, create a key with account:read, store it in VOAR_API_KEY and read your organization's summary:

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

Open the OpenAPI specification

A unit is one minute on the 2 vCPU machine. Larger machines count more units per minute. Fields ending in Micros use millionths of the currency returned by get_account.

Agents without a local browser can use device sign-in with client_id=voar-agent. Start at /oauth/device_authorization, open the returned verification_uri, approve the code and poll /oauth/token at the specified interval.

If the connection fails

  • If the app asks you to sign in again or returns 401, the key no longer works: it was revoked, the GitHub App left the organization, or the person who approved it is no longer an owner or admin. Connect again with an owner or admin account. A revoked key cannot be restored.
  • For 403, the key was created without the permission the tool needs. In Settings, create another key with the missing permission.
  • If you cannot authorize another connection, revoke an unused key in Settings and try again. The list includes keys created by AI apps.
  • For 429, wait for the time in Retry-After before trying again. Keys for the same organization share the limit.
  • If your app does not support a remote server with OAuth, use an MCP client that does, or call the REST API with a key.