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.

list_jobs returns a snapshot of every job on the project’s board — pending, in progress, done, and cancelled — along with each job’s status, priority, current owner, dependency list, and timestamps. It is the coordination primitive you reach for before making decisions: call it on session start to see what’s already in motion, before posting new jobs to check for duplicates, and before claiming in a planned multi-agent run to choose the right task.

Parameters

projectName
string
The Axis project to inspect. Defaults to the auto-detected project (derived from the nearest .git/package.json or a committed .axis/axis.json). Override only when targeting a different project explicitly.

Return Value

An array of job objects. Each object includes:
FieldTypeDescription
jobIdstringUnique identifier for the job — use in claim_job, complete_job, cancel_job, and dependencies arrays
titlestringShort human-readable label set when the job was posted
descriptionstringFull description of the work, including file paths and expected outcomes
statusstringOne of pending, in_progress, done, or cancelled
prioritystringOne of low, medium, high, or critical
claimedBystring | nullAgent ID of the current owner when in_progress; null otherwise
dependenciesstring[]Array of job IDs that must reach done before this job is claimable
createdAtstringISO 8601 timestamp of when the job was posted
updatedAtstringISO 8601 timestamp of the most recent status change

When to Call list_jobs

1

On session start

Before posting or claiming any work, call list_jobs to synchronize with whatever is already in motion. Another agent may have posted jobs for the same feature, or work you planned may already be in_progress. Starting without this check risks duplicated effort and conflicting implementations.
2

Before posting new jobs

If list_jobs returns a job that covers the same work you were about to post, claim that existing job instead of creating a duplicate. The board is shared across all agents and all machines on the org — someone else may have already broken the objective down.
3

Before claiming in a multi-agent run

When a Manager has posted the full job list and multiple workers are starting simultaneously, each worker calls list_jobs to see the board, identifies its intended task, and then calls claim_job(jobId) to claim it specifically. This keeps each agent’s context focused on its own work rather than pulling in whatever claim_next_job serves next.
4

After a long wait or interruption

Before resuming work after any significant pause, call list_jobs (and list_locks) again. Status may have changed — a dependency may have completed, a job you were watching may have been cancelled, or a file you planned to edit may now be locked by a teammate’s agent.

Example Output

[
  {
    "jobId": "j_abc123",
    "title": "Add JWT auth to /api/auth route",
    "description": "Replace session cookie with JWT. Update src/auth.ts. Token payload: {userId, role, exp}.",
    "status": "in_progress",
    "priority": "high",
    "claimedBy": "dana-claude-code",
    "dependencies": [],
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-01-15T10:02:34.000Z"
  },
  {
    "jobId": "j_def456",
    "title": "Add rate limiting to login route",
    "description": "Apply 5 req/min limit to POST /api/auth/login. Follow src/middleware/rateLimit.ts pattern.",
    "status": "pending",
    "priority": "medium",
    "claimedBy": null,
    "dependencies": ["j_abc123"],
    "createdAt": "2025-01-15T10:00:05.000Z",
    "updatedAt": "2025-01-15T10:00:05.000Z"
  },
  {
    "jobId": "j_ghi789",
    "title": "Write unit tests for JWT auth",
    "description": "Cover happy path, expired token, and missing role claim in src/auth.test.ts.",
    "status": "pending",
    "priority": "medium",
    "claimedBy": null,
    "dependencies": ["j_abc123"],
    "createdAt": "2025-01-15T10:00:10.000Z",
    "updatedAt": "2025-01-15T10:00:10.000Z"
  }
]
Reading this board, a new worker agent can immediately understand the situation: the JWT job is already owned by dana-claude-code, so both downstream jobs (j_def456 and j_ghi789) are blocked waiting for it. The worker should wait, or pick up an unrelated job from elsewhere on the board rather than duplicating Dana’s work.
list_jobs returns all statuses including done and cancelled. When scanning for available work, filter on status === "pending" and check that the dependencies array contains no job IDs still in pending or in_progress state. claim_next_job does this filtering automatically if you’d rather not inspect the board manually.

Build docs developers (and LLMs) love