Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/virsanghavi/axis/llms.txt

Use this file to discover all available pages before exploring further.

Account tools give agents programmatic access to the caller’s current plan, entitlements, and API consumption for the billing period. Both tools resolve identity from the authenticated OAuth token or API key — no email or user ID argument is needed. Agents can call these to gate behavior based on available features, or to surface usage information in session summaries.
Agents can call get_subscription_status to gate their behavior — for example, falling back to local ripgrep search instead of surfacing an error when the org is on the free tier. A graceful degradation pattern is always preferable to a hard failure when a feature is unavailable.

get_subscription_status

Returns the caller’s current plan and entitlements. Resolved from the authenticated OAuth token or API key — no arguments required. Parameters: None (resolved from the authenticated session) Returns:
FieldTypeDescription
plan"free" | "pro"The current subscription tier
validUntilISO timestampWhen the current subscription period ends
entitlementsstring[]The list of features available on this plan
orgstringThe org identifier this subscription belongs to
Example response:
{
  "plan": "pro",
  "validUntil": "2026-09-01T00:00:00Z",
  "entitlements": [
    "job_board",
    "file_locks",
    "shared_notepad",
    "sessions",
    "project_soul",
    "hosted_search",
    "deep_search",
    "incremental_indexing"
  ],
  "org": "org_acme"
}

get_usage_stats

Returns API usage for the current billing period. Resolved from the authenticated session — no arguments required. Parameters: None (resolved from the authenticated session) Returns:
FieldTypeDescription
requestCountnumberTotal MCP tool calls made this billing period
searchCountnumberHosted search calls (search_codebase, deep_search) this period
indexedFilesnumberFiles currently in the hosted search index
periodStartISO timestampStart of the current billing period
periodEndISO timestampEnd of the current billing period
limitsobjectPlan limits for each metric
Example response:
{
  "requestCount": 1842,
  "searchCount": 214,
  "indexedFiles": 3091,
  "periodStart": "2026-08-01T00:00:00Z",
  "periodEnd": "2026-09-01T00:00:00Z",
  "limits": {
    "requestCount": null,
    "searchCount": 500,
    "indexedFiles": 10000
  }
}
A null limit means the metric is unrestricted on the current plan.

Free vs. Pro

Axis is open-core. The coordination layer is free for everyone; the intelligence layer is Pro.

Free — coordination layer

Available to all orgs at no cost:
  • Job board (post, claim, complete, cancel, release)
  • Advisory file locks with tamper detection
  • Live shared notepad
  • Session management and transcripts
  • Project soul (local server)
  • Agent presence (list_agents)
  • search_codebase via local ripgrep (no index needed, instant)

Pro — intelligence layer

Hosted features, $20 / seat / month:
  • search_codebase: vector + full-text + trigram, fused and LLM-reranked
  • related files and definitions enrichment in search results
  • deep_search: multi-hop agentic answer engine with citations
  • Incremental hosted indexing (content-hashed, cheap re-runs)
  • Managed backend, dashboard, live team board
  • Audit trails and session history

Graceful degradation pattern

Agents working on mixed-tier orgs should degrade gracefully rather than failing when a Pro feature is unavailable. Check the plan before reaching for hosted intelligence tools:
// Pseudocode — agent decision logic

const { plan, entitlements } = await get_subscription_status();

if (entitlements.includes("hosted_search")) {
  // Use hosted vector search with reranking
  const results = await search_codebase({ query, projectName });
  // results.related and results.definitions are populated
} else {
  // Fall back to instant local ripgrep — still useful, just without
  // the vector layer, related files, and definitions enrichment
  const results = await search_codebase({ query, projectName });
  // results.hits are still returned from ripgrep
}
When an upgrade is needed, surface a clear message rather than a cryptic error. The hosted server automatically includes an upgrade prompt in tool responses when a free org calls a Pro-only tool.

Billing and org seats

Orgs are billed per active member at $20 / seat / month. Seat count equals the number of active org members — adding a member adds a seat, removing one frees it (prorated via Stripe). Admins manage billing from /billing on the dashboard. Every account starts as a one-person org, so solo users are unaffected by team billing until they invite a teammate. Once you invite someone, all agents — yours and theirs — coordinate on the same project without clobbering each other: shared job board, shared file locks, and a shared codebase index.

Build docs developers (and LLMs) love