Connect a client#
Start with the coding-tool connection guide. Tool names keep the agentx_ prefix. The coding client calls these tools; you normally ask for the action in plain language.
Direct-task tools (v0.3.1)#
| Tool | Use |
|---|---|
agentx_whoami
|
Check your environment and sign-in
Returns developer identity, environment and API versions. |
agentx_list_projects
|
Find projects you can use
Returns authorized projects and their task/sharing policies. |
agentx_start_task
|
Delegate a task
Give the exact project name and complete instructions. Returns a task ID; wait_seconds is optional. |
agentx_get_task
|
Inspect status and results
Returns progress, changed files, artifacts and PR links when available. |
agentx_wait_for_task
|
Wait for work to end
Waits 1–600 seconds. A timeout does not stop the task. |
agentx_list_tasks
|
Find your existing tasks
Lists tasks; use the returned IDs to inspect or continue them. |
agentx_continue_task
|
Send a follow-up
Requires the task ID and complete new instructions. Reuses the workspace and branch after the current run ends. |
agentx_cancel_task
|
Stop current work
Cancels the task; cancelling a wait alone does not do this. |
agentx_close_task
|
Release the workspace
Checks for unpublished work; inspect the result if closure refuses. |
agentx_share_task
|
Share into the project’s Slack channel
View lets others watch; continue permits follow-ups when project policy allows. |
agentx_open_pull_request
|
Request a PR
Requires task ID and title. Draft defaults to true; inspect the task later for the PR URL. |
Workflow tools#
These tools support Quick/Full workflow tasks and are included in v0.3.4. Use the tools your deployed server advertises.
| Tool | Use |
|---|---|
agentx_start_workflow
|
Start a workflow with project, complete instructions and a required workflow_path (quick or full). Returns the task and workflow state. |
agentx_decide_workflow
|
Decide on the current document with task_id, expected_revision, artifact_digest, decision, reason and a retry-safe request_id. |
agentx_review_workflow_candidate
|
Reviews start on their own after checks pass. Use this to retry a blocked review, with the exact expected_revision and candidate_digest; refused if the code or checks changed. |
agentx_retry_workflow
|
Restart blocked read-only planning or blocked coding, or rerun checks for a blocked VERIFY stage. Rerunning checks needs expected_revision. |
agentx_send_workflow_back
|
Send a blocked change back to coding with the failed checks and findings the change introduced, plus your instructions. Owner only. |
agentx_resolve_review_findings
|
Answer every blocking finding: accept with a reason (listed in the draft PR) or fix with optional instructions. At most 20 per call. Owner only. |
agentx_retry_workflow_publish
|
Retry opening the draft PR for the code whose checks and reviews passed. Owner only. |
agentx_get_pr_feedback
|
Read AgentX’s proposal for PR comments: each finding’s ID, priority, recommendation, proposed change or question, and the comments it answers. Owner only. |
agentx_decide_pr_feedback
|
Decide that proposal: APPROVE (optionally naming finding_ids), REQUEST_CHANGES, DISMISS or RETRY_REVIEW. Copy the digests from agentx_get_pr_feedback. Owner only. |
agentx_keep_pull_request
|
After an approved feedback fix changed no code, keep the PR as it is and wait for the merge again. Owner only. |
Task People tools (mainline)#
These tools show and propose changes to who can use a task. Role changes and invitations are behind environment settings that default to off.
| Tool | Use |
|---|---|
agentx_get_task_people
|
Show the current People revision and who can use the task. Use person_id, not names, for changes. |
agentx_get_task_people_request
|
Check the receipt of a People request. It never confirms a pending request. |
agentx_set_task_person
|
Propose a role change. A human must confirm before it commits. |
agentx_take_task_ownership
|
Propose taking ownership of an orphaned task. A human must confirm before it commits. |
Decision inputs#
| Field | Meaning |
|---|---|
| task_id | The existing workflow task. |
| expected_revision | The current positive workflow revision from the task. |
| artifact_digest | The SHA-256 of the current approval document. |
| decision | APPROVE, REQUEST_CHANGES, REJECT or SKIP. SKIP is refused unless the project allows it. |
| reason | A non-empty reason for the decision (maximum 500 characters). |
| request_id | A UUID for safe retry. Repeat the same request unchanged after a timeout. |
The server validates identity, state and freshness. Never reuse an older document digest to approve a revised plan. Workflow and feedback calls that carry an expected revision or digest are refused when the task has moved on; read the task again and decide on the current state.
Waits and retries#
Waits can time out without cancelling the task. Check the existing task before starting duplicate work. Mutating tools use request IDs to recognize retries; a new request ID means a new action.
Continuing a task that is still running returns TASK_BUSY. Wait for its current run to end.
Access and sharing#
Project access and task policy are enforced by the server. Sharing into Slack must follow that project’s channel and sharing policy. Additional admin tools depend on a valid admin sign-in; they are outside this developer-tool table.