for agents: this page is markdown at https://switchyard.so/docs/parity.md; every page is listed in llms.txt.
Board, API, CLI and MCP
Everything the board does can be done without it: through the REST API, through the yard CLI, and for a project's own work through the MCP server agents use. This page lists every action on the board with its API route, its yard command and its MCP tool, and says why where one has none. A few actions stay on the board on purpose; a table says which, and why. The last section lists every route with its yard command and MCP tool.
Project routes are under https://app.switchyard.so/v1/projects/<project> and take a project's admin key, a task key, an agent group key or a signed-in person. Organization and account routes are under https://app.switchyard.so/api and act for a person signed in (yard login https://app.switchyard.so --github). The MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions have no MCP tool: they take a person's sign-in, which yard holds and an agent's key does not.
Tasks
| On the board | API | yard | MCP |
|---|---|---|---|
| See main, the tasks and the merge queue | GET /status | yard status | yard_status |
| See the project itself: its name, main branch, remote and the GitHub repository it follows | GET /v1/projects/<project> | yard project show | yard_whoami |
| See the active tasks, and the merged and abandoned ones a page at a time | GET /workspaces, GET /workspaces?status=finished | yard branch list [--finished], yard status --all | yard_status, yard_finished |
| See the organization's spending limit: the share used, the forecast and who can raise it (raising it is a person's, on the billing page) | GET /spending-limit | yard api GET /v1/projects/{project}/spending-limit reads it with the project's key; yard org limit reads the organization's own limit (GET /api/orgs/:org/billing/limit) with your sign-in | yard_spending_limit |
| Start a task | POST /workspaces | yard branch new | yard_workspace_create |
| Give a task its plan | PUT /workspaces/:workspace/plan | yard plan | yard_plan |
| Tag a task | POST /workspaces/:workspace/tags | yard tag | yard_tag |
| Assign a task to a person | POST /workspaces/:workspace/ops | yard assign | yard_assign |
| Abandon a task, saying why if you like | POST /workspaces/:workspace/ops with op abandon and args.reason | yard abandon [--reason] | yard_workspace_op |
| Read what overlaps with a task | GET /workspaces/:workspace/warnings | yard warnings | yard_warnings |
| Read Switchyard's note on a task: what it last changed, its merge queue place, its conflicts | GET /workspaces/:workspace/notice | yard notice | yard_notice |
| Submit a task | POST /workspaces/:workspace/submit | yard submit | yard_submit |
| Merge a task first, as a hotfix (no board screen) | POST /workspaces/:workspace/ops | yard hotfix | yard_priority |
| Merge a task in the priority lane, after hotfixes and before the normal lane (no board screen) | POST /workspaces/:workspace/ops | yard priority | yard_priority |
| Replace a task's key | POST /workspaces/:workspace/key | yard branch key | yard_task_key |
Review, conflicts and history
| On the board | API | yard | MCP |
|---|---|---|---|
| Read the review inbox | GET /status | yard review | yard_review |
| Approve a change, ask for a fix or comment, bound to the commit you read (refused if the version now names another) | POST /review/:change/:version with commit | yard review approve, yard review request-fix, yard review comment (send the inbox item's commit) | yard_review with commit |
| Read a change, its versions and its diff | GET /changes/:change, GET /changes/:change/interdiff | yard show | yard_change |
| See the conflicts and the steps tried | GET /conflicts | yard conflicts | yard_conflicts |
| Read each side and the base of a conflicted file | GET /conflicts/:change/sides | yard conflicts --sides | yard_conflict_sides |
| Fix a conflict | POST /conflicts/:change/resolve | yard resolve | yard_resolve |
| Read the project's history | GET /oplog | yard log | yard_log |
| Undo an action | POST /oplog/:seq/undo | yard undo | yard_undo |
| Find which change wrote a line | GET /why | yard why | yard_why |
| Check a merged commit's signed merge record | GET /attestations/:commit | yard verify | yard_attestation |
Read the project's signing key, to pin it in .yard/allowed_signers | GET /signer | yard verify --signer | yard_signer |
| Read a check's full log | GET /checks/logs/<id> | yard check log | yard_check_log |
| Run a command in a failed check's kept machine | POST /checks/<id>/shell | yard check shell <check> -c | yard_check_shell |
| End a kept machine | DELETE /checks/<id>/shell | yard check shell <check> --done | yard_check_shell with done |
| Read the project's numbers over time | GET /insights | yard insights | yard_insights |
| See the merge queue's health | GET /queue-health | yard queue health | yard_queue_health |
| Tell the Switchyard team an answer confused an agent (no board screen; read on the admin page) | POST /feedback | yard feedback | yard_feedback |
Running the project
| On the board | API | yard | MCP |
|---|---|---|---|
| See whether Switchyard, GitHub and Cloudflare are working (the live indicator) | GET /v1/upstream | yard status (its first line, when something is wrong) | yard_status (its upstream) |
| Read the settings | GET /settings | yard settings | yard_settings |
| Turn reviews on or off | PUT /reviews | yard settings set reviews | yard_setting |
| Let conflict fixes merge by themselves, or wait for approval | PUT /fixes | yard settings set fixes | yard_setting |
| Choose who submits a task | PUT /task-permission | yard settings set who-submits | yard_setting |
| Choose whether opening the project wakes the Git engine | PUT /wake-on-open | yard settings set wake-on-open | yard_setting |
| Choose what the checks may reach on the network | PUT /checks/network | yard settings set check-network | yard_setting |
| Choose whether a task's failed check keeps its machine | PUT /keep-failed-machines | yard settings set keep-failed-machines | yard_setting |
| Choose whether the Git engine stays warm for an hour after work | PUT /warm-hour | yard settings set warm-hour | yard_setting |
| Choose whether the person whose task it is may approve its protected changes | PUT /self-approval | yard settings set self-approval | yard_setting |
Choose the apps that write, such as renovate[bot] (adding one is a person's, in a browser) | PUT /allowed-apps | yard settings set allowed-apps | yard_setting |
| Choose whether checks keep their package downloads between runs | PUT /build-cache | yard settings set build-cache | yard_setting |
| Choose whether a task waiting for review runs its checks while it waits | PUT /checks-while-reviewing | yard settings set checks-while-reviewing | yard_setting |
| Choose whether a task's checks run ahead of submit once its pushes go quiet | PUT /checks-before-submit | yard settings set checks-before-submit | yard_setting |
| Choose whether the Git engine grows to a larger machine under load (hosted: the organization's choice, and letting it grow is a person's, in a browser) | PUT /engine-sizing | yard settings set engine-sizing | yard_setting |
| Choose whether the integration is rebuilt only where tasks moved | PUT /incremental-rebuild | yard settings set incremental-rebuild | yard_setting |
| Choose whether the engine merges path by path | PUT /grouped-merge | yard settings set grouped-merge | yard_setting |
| Choose whether a push to a merged task continues it as a new change | PUT /continue-merged | yard settings set continue-merged | yard_setting |
| Choose whether tasks that touch nothing in common ride separate merge trains (no control on the settings page yet; off for every project) | PUT /merge-trains | yard settings set merge-trains off sends; on prints the link: where people sign in, turning it on is a person's act in a browser signed in within 15 minutes, so yard prints the project's settings page's link and exits 8 (approval_required); there is no control on the settings page yet, and Switchyard turns merge trains on for a project on request | yard_setting: off is done; on is answered approval_required with the project's settings page |
| Keep the rules and checks in Switchyard | PUT /rules | yard rules show, yard rules keep | yard_rules_keep |
| Say a path needs no check ("this path needs no check") | POST /rules/unchecked | yard rules unchecked | yard_unchecked |
| Choose whether a change only to documentation needs a check | PUT /docs-excused | yard settings set docs-excused | yard_setting |
| Start holding untested changes before the guard's seven days of watching end | POST /untested-guard/enforce | yard rules enforce | yard_untested_guard_enforce |
| Add the protected areas a project set up before them misses (projects that follow GitHub) | GET /api/projects/<project>/protected-areas, POST with { ids } | yard rules protect [--add] | not yet: an agent's key has no person on GitHub to answer for the change |
| Turn a kept check off or back on | PUT /checks/off | yard check off, yard check on | yard_checks_off |
| Try the checks that are off on main again | POST /checks/try, GET /checks/tried | yard check try, yard check tried | yard_checks_try, yard_checks_tried |
| Pause merging, and resume it | PUT /pause, DELETE /pause | yard pause, yard resume | yard_pause, yard_resume |
| Copy the GitHub repository again after a failed first copy | POST /copy-again | yard copy-again | yard_copy_again |
| Cancel the copy of the repository's history behind main, and copy it again | DELETE /copy-history, POST /copy-history | yard copy-history --cancel, yard copy-history | yard_copy_history |
| Wake the project's Git engine ahead of work, and see what the project is doing | POST /engine/wake, activity on GET /status | yard engine wake [--wait], yard status [--watch] | yard_wake_engine, activity in yard_status |
| Set up a project for a repository | POST /v1/projects | yard init | signed-in person: making a project acts for a person across projects, and the MCP server works inside one project |
| Set a GitHub repository up: the App's installations, the repositories, the checks and rules drafted from its CI, then commit them or open a pull request | GET /api/onboarding/github, GET /api/onboarding/repositories, GET /api/onboarding/analysis, POST /api/onboarding/setup | yard setup github, yard setup repos, yard setup analyze [--plan], yard setup apply | signed-in person: it answers to a person's own access on GitHub; it stays allowed with the person's yard sign-in, so an agent sets a repository up for its person, but no key or MCP tool does |
| Choose where a project's checks run: Switchyard's machines or the repository's own GitHub Actions | POST /api/onboarding/checks-on | yard setup checks-on | signed-in person: the change answers to a person's own access on GitHub |
| Show the command that clones main | POST /main/credentials | yard fetch | yard_git_credentials with main |
| Rotate, disable, enable or revoke an agent group key | POST /fleets/:fleet/:action | yard group <F> disable and yard group <F> revoke send, so a leaked key is stopped fast; yard group <F> rotate and yard group <F> enable print the link, since a person does them in a browser signed in within 15 minutes (exit 8, approval_required); of keys, only the project admin key itself still rotates and enables | yard_agent_group_key: revoke and disable are done; rotate and enable are answered approval_required with the project's settings page for an agent signed in over MCP and for every organization key |
| Make an agent group key, and list them | POST /fleets, GET /fleets | yard group list; yard group create prints the link, since a person makes a key in a browser signed in within 15 minutes (exit 8, approval_required); of keys, only the project admin key itself still makes one | yard_agent_groups; yard_agent_group_create is answered approval_required with the project's settings page for an agent signed in over MCP and for every organization key |
| Rotate the project's admin key | POST /admin-key/rotate | yard project rotate-admin-key --confirm prints the link: a person with admin access rotates it in a browser signed in within 15 minutes, so yard prints the project's settings page's link and exits 8 (approval_required) | signed-in person: every earlier admin key stops at once, so Switchyard takes it only from a person with admin access to the project, in a browser signed in within 15 minutes, never from a key, the admin key itself included |
| Add, list and remove webhooks | POST /webhooks, GET /webhooks, DELETE /webhooks/:id | yard webhook add, yard webhook list, yard webhook remove | yard_webhooks |
| Send a webhook endpoint a test event and see its result | POST /webhooks/:id/test | yard webhook test | yard_webhooks with action: "test" |
| See and forget remembered conflict resolutions | GET /resolutions, DELETE /resolutions/:key | yard resolutions, yard resolutions forget | yard_resolutions |
| Set up a coding agent on a computer | POST /api/setup-codes | yard agent setup | internal: it is how an agent gets the MCP server, so the server has no tool for it |
| Schedule a project's deletion, or keep the project | POST /api/projects/:project/deletion, DELETE /api/projects/:project/deletion | yard project deletion reads it and yard project keep keeps the project; yard project delete prints the link: a person schedules a deletion in a browser signed in within 15 minutes, so yard prints the project's settings page's link and exits 8 (approval_required) | signed-in person: an owner or admin of the organization schedules it in a browser, and keeps the project with their sign-in |
Working in a checkout
These have no button on the board: they are how an agent or a person works in a task's own Git checkout.
| What | API | yard | MCP |
|---|---|---|---|
| Open a task in a checkout, with its Git key | POST /workspaces/:workspace/credentials | yard branch open, yard credential | yard_git_credentials |
| Take a task as one of many agents sharing a key | POST /workspaces/claim | yard branch new with the agent group key | yard_workspace_claim |
| Say which paths and symbols a task will touch | POST /workspaces/:workspace/claims | yard claim | yard_claim |
| Bring main, or the task below, into a task | POST /workspaces/:workspace/ops | yard sync | yard_sync |
| Commit, and shape the task's stack | Git push to the task, POST /workspaces/:workspace/ops | yard commit, yard absorb, yard split, yard squash, yard move, yard uncommit, yard edit | yard_absorb, yard_split, yard_squash, yard_workspace_op |
| Send the pushes queued while Switchyard could not be reached | none: the queue lives in the checkout's .git and is sent with Git | yard push --queued, and yard status --local lists it | none: an MCP agent pushes with plain Git, which queues nothing; its commits stay on its branch to push again once Switchyard answers |
| Run a coding agent in a task | none: the agent runs on your own computer | yard agent run | internal: it starts the agent that then uses the MCP server |
| Check a webhook request's signature | none: the check runs on your own computer and sends nothing to Switchyard | yard webhook verify | none: the signing secret stays on your computer, so the MCP server has no tool for it |
| Sign in, check the setup and the shell | GET /api/me | yard login, yard logout, yard whoami, yard doctor, yard completions | yard_whoami reads the key's or agent's own identity in the project (GET /me); GET /api/me is a signed-in person's, with no MCP tool |
Organizations
| On the board | API | yard |
|---|---|---|
| List your organizations | GET /api/orgs | yard org list |
| See the members and their teams | GET /api/orgs/:org/members | yard org members |
| List the projects you can see | GET /v1/projects | yard project list |
| Invite someone by GitHub login | POST /api/invitations | yard org invite prints the link: inviting is a person's act in a browser signed in within 15 minutes, so yard prints the teams page's link and exits 8 (approval_required) |
| See and withdraw open invitations | GET /api/orgs/:org/invitations, POST /api/auth/organization/cancel-invitation | yard org invitations, yard org withdraw |
| Answer an invitation sent to you | GET /api/invitations, POST /api/auth/organization/accept-invitation, POST /api/auth/organization/reject-invitation | yard org invited, yard org accept, yard org decline |
| Change a member's role, or remove them, keeping chosen keys for the team | GET /api/orgs/:org/members/:member/keys, POST /api/orgs/:org/members/:member/role, POST /api/orgs/:org/members/:member/remove | yard org role --keep, yard org remove --keep print the link: a person does both in a browser signed in within 15 minutes, so yard prints the teams page's link and exits 8 (approval_required) |
| Leave an organization | POST /api/orgs/:org/leave | yard org leave prints the link: a person leaves in a browser signed in within 15 minutes, so yard prints the teams page's link and exits 8 (approval_required) |
| Make, rotate, disable, enable, revoke and keep for the team API keys | GET /api/orgs/:org/keys, POST /api/orgs/:org/keys, POST /api/orgs/:org/keys/:key/:action | yard org keys; yard org key disable and yard org key revoke send, so a leaked key is stopped fast; yard org key create, yard org key rotate, yard org key enable and yard org key keep print the link, since a person does them in a browser signed in within 15 minutes (exit 8, approval_required) |
| Turn AI conflict fixes on or off | GET /api/orgs/:org/ai-fixes, PUT /api/orgs/:org/ai-fixes | yard org ai-fixes reads them; yard org ai-fixes on prints the page, since turning them on or off is browser only: they spend on the bill, so a person does it in a browser signed in within 15 minutes |
| Read the month's usage | GET /api/orgs/:org/usage | yard org usage |
| Read a month's bill and every check run in it | GET /api/orgs/:org/billing, GET /api/orgs/:org/billing/runs.csv | yard org billing |
| Choose who else gets billing emails, beside the owners, admins and billing members | GET /api/orgs/:org/billing (its contacts), PUT /api/orgs/:org/billing/contacts | yard org billing contacts reads them; with --add or --remove it prints the link: a person changes who gets the billing emails in a browser signed in within 15 minutes, so yard prints the billing page's link and exits 8 (approval_required) |
| Set a spending limit: an email at a warning amount; at the limit, pushes, new tasks and submits are kept but nothing is tested or merged, and after 24 hours or $2 of engine time, whichever comes first, new work is refused (clones and fetches keep working) | GET /api/orgs/:org/billing/limit, PUT /api/orgs/:org/billing/limit | yard org limit; yard org limit set prints the billing page's link to confirm it in a browser |
| Raise the spending limit in one click: +$100, +$500, remove it, or allow until tomorrow (a person who looks after billing, in a browser, never a key or a yard sign-in) | POST /api/orgs/:org/billing/limit/raise, GET /api/orgs/:org/billing/limit/offer for an email's link | browser only: a person who looks after billing, in a browser session from the last 15 minutes, never a key or a yard sign-in |
| Make and remove teams, and add and take out their members (owners and admins) | POST /api/orgs/:org/teams, DELETE /api/orgs/:org/teams/:team, POST and DELETE /api/orgs/:org/teams/:team/members | yard org team create, yard org team delete, yard org team add and yard org team remove print the teams page's link: who is on a team decides who reviews what, so a person makes or removes a team, and adds or takes out a member, in a browser signed in within 15 minutes (exit 8, approval_required) |
| Rename an organization (owners only) | POST /api/auth/organization/update | yard org rename |
| Delete an organization (owners only, once it owns no project and its billing has not started) | POST /api/auth/organization/delete | yard org delete prints the page, since deleting is browser only: it cannot be undone, so its owner does it in a browser signed in within 15 minutes |
| Set or remove an organization secret for hosted agent runs (owners only; hosted agent runs are off today, and AI suggestions never read one) | PUT /api/orgs/:org/secrets/:name, DELETE /api/orgs/:org/secrets/:name | yard org secret prints the page, since a secret is browser only: its owner types it in a browser signed in within 15 minutes, and no command line or chat ever carries it |
| See an organization, its plan and teams | GET /api/orgs/:org, GET /api/orgs/:org/teams, GET /api/orgs/:org/teams/:team/members | yard org show, yard org teams, yard org members --team |
| Read the organization's audit log by kind, person, outcome and dates, and export it (the audit log page) | GET /api/orgs/:org/audit, with format=csv or format=jsonl | yard org audit |
| See the projects the organization deleted lately, who asked, and until when their data is kept | GET /api/orgs/:org/deleted-projects | yard org deleted |
| Make an organization (the sign-up step); an agent's account is refused, and on open sign-up so is an account whose email is not proven | POST /api/auth/organization/create | yard org create prints the teams page's link: a new organization is a person's choice, so a person makes it in a browser where they are signed in, however long ago (exit 8, approval_required), and yard refuses an agent's or a script's run before sending; then yard init --organization makes a project in it |
| See the card and where payments stand, and add or change the card on Stripe's page (the first card pays the plan's minimum for the rest of the month) | GET /api/orgs/:org/billing/card, POST /api/orgs/:org/billing/card with { plan? } | yard org card reads it; yard org card add prints the link: a person adds or changes the card in a browser where they are signed in, however long ago, so yard prints the billing page's link and exits 8 (approval_required), and the person chooses there the plan whose minimum the first card pays |
| Read the statements and their invoices: what was charged, when, and what waits for review (no board screen) | GET /api/orgs/:org/billing/invoices | yard org invoices |
| Choose whether the organization's Git engines grow to a larger machine under load, billed at that size, or stay small (owners and admins) | GET /api/orgs/:org/engine-sizing, PUT /api/orgs/:org/engine-sizing | yard org engine-sizing reads it and keeps them small; yard org engine-sizing your-org grows prints the page, since letting them grow is a person's, in a browser |
| See single sign-on: its connections, whether it is required and the DNS records still to add | GET /api/orgs/:org/sso | yard org sso |
| Check a single sign-on connection's DNS records now (owners) | POST /api/orgs/:org/sso/:provider/verify | yard org sso verify |
| Set up, remove or require single sign-on (owners; Scale and Enterprise) | POST /api/orgs/:org/sso, DELETE /api/orgs/:org/sso/:provider, PUT /api/orgs/:org/sso-required | browser only: an owner does it in a browser signed in within 15 minutes; yard org sso prints the page |
| See the SCIM directory: whether one is paired, with which connection, and how many people it holds | GET /api/orgs/:org/scim | yard org scim |
| Pair, make the directory key again for, or unpair the SCIM directory (owners; Enterprise) | POST /api/orgs/:org/scim, DELETE /api/orgs/:org/scim | browser only: the directory key is a secret shown once, so an owner does it in a browser signed in within 15 minutes; yard org scim prints the page |
| See the two-factor level and how members are covered | GET /api/orgs/:org/two-factor | yard org two-factor |
| Set the two-factor level: recommended or required (owners) | PUT /api/orgs/:org/two-factor-required | browser only: a security setting an owner changes in a browser signed in within 15 minutes; yard org two-factor prints the page |
| See the IP allowlist, and whether your address is in it (no board screen) | GET /api/orgs/:org/ip-allowlist | none: a member reads it with their sign-in; yard api GET /api/orgs/your-org/ip-allowlist sends it |
| Set the IP allowlist (owners; no board screen) | PUT /api/orgs/:org/ip-allowlist | browser only: a security setting an owner changes in a browser signed in within 15 minutes, from an address the new list allows |
Your account
| On the board | API | yard |
|---|---|---|
| See who you are signed in as | GET /api/me | yard whoami |
| Sign in, and sign out | /api/auth/device/code, POST /api/auth/sign-out | yard login --github, yard logout |
| See where you are signed in, and sign one or all out | GET /api/sessions, DELETE /api/sessions/:id, POST /api/auth/revoke-sessions | yard account sessions, yard account sessions end <id>; yard account sessions end --all prints the link: signing out everywhere is a person's act in a browser where they are signed in, however long ago, so yard prints the account page's link and exits 8 (approval_required) |
| Choose which emails Switchyard sends you | GET /api/me/emails, PUT /api/me/emails | yard account emails, yard account emails set |
| Set up two-factor sign-in: an authenticator app, its backup codes and passkeys | /api/me/two-factor, /api/me/passkeys | browser only: a person does it in a browser signed in within 15 minutes; no key and no agent does it |
| Report a bug from the board's side panel | POST /api/me/bug-reports | none: it is a person's own report from a page; an agent tells the Switchyard team with yard feedback and yard_feedback |
| See and end the agents you signed in over MCP | GET /api/me/agents, DELETE /api/me/agents/:agent | yard account agents, yard account agents end |
| See your notifications, mark them read or clear them | GET /api/me/notifications, POST /api/me/notifications/read, POST /api/me/notifications/clear | yard notifications, yard notifications read, yard notifications clear; the bell marks what it showed seen, which yard never does. An agent signed in over MCP as its person reads that person's open reviews and tasks of one project with yard_notifications |
| Mute a task or a project, and lift it | POST /api/me/notifications/mute | yard notifications mute, yard notifications unmute |
| Choose what reaches you and how, and the daily summary | GET /api/me/notification-settings, PUT /api/me/notification-settings | yard notifications settings, yard notifications settings set, yard notifications settings unset, yard notifications settings summary |
Any route
| Action | API | yard |
|---|---|---|
Send any route on this page with the key yard would use, for what no command does: a project's routes with the project's key, /api routes with your sign-in | any route | yard api <METHOD> <path>, with {project} and {task} filled in; a change needs --yes off a terminal |
On the board only, on purpose
| Action | Why it stays on the board |
|---|---|
| Let a project's conflict records help improve conflict fixing | It is consent, so a person gives it on the settings page, in a browser. No key, no yard sign-in and no agent can give it. |
| Delete your account | It cannot be undone, so it takes a browser signed in within 15 minutes, never a yard sign-in. |
| Switchyard's own admin pages | They are for the people who run Switchyard, not for organizations. |
The website's waitlist and contact forms (/api/waitlist and /api/contact on https://switchyard.so) are a person's, in a browser, behind a bot check. They have no API route in the map, no yard command and no MCP tool.
Every MCP tool is on this page, and so is every yard command in the CLI page's command table. A test fails when one of them is added without its row, and when a row leaves a way out without saying why. The CLI page lists every command at every level but the ones only Switchyard's own team runs, so a third-level command such as yard org key create is checked too.
<!-- every route: rendered from the API map by node scripts/docs-reference.mjs -->
Every route
This table is rendered from the API map, the product's own list of its routes, which a test holds to the routes the code answers, so it changes when a route does. Paths are under https://app.switchyard.so. A route with no yard command or MCP tool says why: browser only is a person's own act in a browser signed in within 15 minutes (consent, the spending limit, billing contacts, approvals a person confirms, approving yard's sign-in, AI fixes, the organization's agent switches, deleting the account or an organization, organization secrets, single sign-on, the SCIM directory, security settings and a team's members), or, for making an organization, in a browser signed in at any time, that no key and no yard sign-in may do; signed-in person takes a person's sign-in, which yard holds after yard login --github, never a key, and which the MCP server, working inside one project with its keys, does not hold (people and roles, organizations, rotating an admin key); internal is the plumbing another way uses; no command means yard has no command of its own that calls the route, and yard api sends it with yard's key or sign-in. The routes Switchyard's own team uses and the steps of signing in are left out. The same routes are described for machines in the OpenAPI document.
Tasks
| Route | yard | MCP |
|---|---|---|
GET /v1/projects/{project}/workspaces | yard branch list | yard_finished |
POST /v1/projects/{project}/workspaces | yard branch new | yard_workspace_create |
DELETE /v1/projects/{project}/workspaces | internal: a client that gives up a create it keeps sending (yard, the MCP server) calls it with the create's key itself; no person or agent asks for it | internal: a client that gives up a create it keeps sending (yard, the MCP server) calls it with the create's key itself; no person or agent asks for it |
POST /v1/projects/{project}/workspaces/claim | internal: it serves the MCP server's yard_workspace_claim only; yard branch new starts a task by the route that creates one | yard_workspace_claim |
DELETE /v1/projects/{project}/workspaces/claim | internal: a client that keeps sending a claim gives it up here with the claim's key; yard sends no claims | internal: a client that keeps sending a claim gives it up here with the claim's key; yard_workspace_claim's withdraw gives up its own claims by the route that gives up a create instead |
PUT /v1/projects/{project}/workspaces/{workspace}/plan | yard plan | yard_plan |
POST /v1/projects/{project}/workspaces/{workspace}/tags | yard tag | yard_tag |
GET /v1/projects/{project}/workspaces/{workspace}/warnings | yard warnings | yard_warnings |
GET /v1/projects/{project}/pulls/{number} | yard pr status | yard_pr_status |
GET /v1/projects/{project}/workspaces/{workspace}/notice | yard notice | yard_notice |
POST /v1/projects/{project}/workspaces/{workspace}/observe | yard commit | yard_warnings |
POST /v1/projects/{project}/workspaces/{workspace}/claims | yard claim | yard_claim |
POST /v1/projects/{project}/workspaces/{workspace}/ops | yard sync | yard_workspace_op |
POST /v1/projects/{project}/workspaces/{workspace}/credentials | yard branch open | yard_git_credentials |
POST /v1/projects/{project}/main/credentials | yard fetch | yard_git_credentials |
POST /v1/projects/{project}/workspaces/{workspace}/retry | signed-in person: a person decides that a check's failures with no cause found were not the task's, never an agent, so no MCP tool retries it; yard has no command for it: a person signed in with yard login calls the route with yard api | signed-in person: a person decides that a check's failures with no cause found were not the task's, never an agent, so no MCP tool retries it; yard has no command for it: a person signed in with yard login calls the route with yard api |
POST /v1/projects/{project}/workspaces/{workspace}/submit | yard submit | yard_submit |
Review, conflicts and resolutions
| Route | yard | MCP |
|---|---|---|
GET /v1/projects/{project}/resolutions | yard resolutions | yard_resolutions |
DELETE /v1/projects/{project}/resolutions/{key} | yard resolutions forget | yard_resolutions |
GET /v1/projects/{project}/changes/{change} | yard show | yard_change |
GET /v1/projects/{project}/changes/{change}/interdiff | yard show | yard_change |
GET /v1/projects/{project}/conflicts | yard conflicts | yard_conflicts |
GET /v1/projects/{project}/conflicts/{change}/sides | yard conflicts --sides | yard_conflict_sides |
POST /v1/projects/{project}/conflicts/{change}/resolve | yard resolve | yard_resolve |
GET /v1/projects/{project}/agent-approvals | no command: a person's yard org agent-approvals reads the organization's setting through GET /api/orgs/{org}/agent-approvals; yard api GET /v1/projects/{project}/agent-approvals reads this route | yard_review |
GET /v1/projects/{project}/review/pending/{pending} | yard review approve --wait | browser only: an approval of a protected change waits for the same person to confirm it in a browser signed in within 15 minutes, never with a key or a yard sign-in |
POST /v1/projects/{project}/review/pending/{pending} | browser only: an approval of a protected change waits for the same person to confirm it in a browser signed in within 15 minutes, never with a key or a yard sign-in | browser only: an approval of a protected change waits for the same person to confirm it in a browser signed in within 15 minutes, never with a key or a yard sign-in |
POST /v1/projects/{project}/review/{change}/{version} | yard review approve | yard_review |
History, records and numbers
| Route | yard | MCP |
|---|---|---|
GET /v1/projects/{project}/insights | yard insights | yard_insights |
GET /v1/projects/{project}/value | yard value | yard_value |
GET /v1/projects/{project}/why | yard why | yard_why |
GET /v1/projects/{project}/attestations/{commit} | yard verify | yard_attestation |
GET /v1/projects/{project}/signer | yard verify --signer | yard_signer |
GET /v1/projects/{project}/oplog | yard log | yard_log |
POST /v1/projects/{project}/oplog/{seq}/undo | yard undo | yard_undo |
Rules and checks
| Route | yard | MCP |
|---|---|---|
PUT /v1/projects/{project}/rules | yard rules keep | yard_rules_keep |
POST /v1/projects/{project}/rules/unchecked | yard rules unchecked | yard_unchecked |
POST /v1/projects/{project}/untested-guard/enforce | yard rules enforce | yard_untested_guard_enforce |
GET /v1/projects/{project}/checks/tried | yard check tried | yard_checks_tried |
GET /v1/projects/{project}/checks/logs/{log} | yard check log | yard_check_log |
POST /v1/projects/{project}/checks/{check}/shell | yard check shell | yard_check_shell |
DELETE /v1/projects/{project}/checks/{check}/shell | yard check shell --done | yard_check_shell |
PUT /v1/projects/{project}/checks/off | yard check off | yard_checks_off |
POST /v1/projects/{project}/checks/try | yard check try | yard_checks_try |
GET /api/projects/{project}/protected-areas | yard rules protect | signed-in person: the change answers to a person's own access on GitHub, which an agent's key does not have |
POST /api/projects/{project}/protected-areas | yard rules protect --add | signed-in person: the change answers to a person's own access on GitHub, which an agent's key does not have |
Settings and webhooks
| Route | yard | MCP |
|---|---|---|
GET /v1/projects/{project}/settings | yard settings | yard_settings |
PUT /v1/projects/{project}/checks/network | yard settings set check-network | yard_setting |
GET /v1/projects/{project}/webhooks | yard webhook list | yard_webhooks |
POST /v1/projects/{project}/webhooks | yard webhook add | yard_webhooks |
DELETE /v1/projects/{project}/webhooks/{webhook} | yard webhook remove | yard_webhooks |
POST /v1/projects/{project}/webhooks/{webhook}/test | yard webhook test | yard_webhooks |
PUT /v1/projects/{project}/conflict-data | browser only: it is consent to use the project's conflict records: a person gives it in a browser signed in within 15 minutes, never with a key or a yard sign-in; an undo never changes it | browser only: it is consent to use the project's conflict records: a person gives it in a browser signed in within 15 minutes, never with a key or a yard sign-in; an undo never changes it |
PUT /v1/projects/{project}/wake-on-open | yard settings set wake-on-open | yard_setting |
PUT /v1/projects/{project}/allowed-apps | yard settings set allowed-apps | yard_setting |
PUT /v1/projects/{project}/self-approval | yard settings set self-approval | yard_setting |
PUT /v1/projects/{project}/build-cache | yard settings set build-cache | yard_setting |
PUT /v1/projects/{project}/grouped-merge | yard settings set grouped-merge | yard_setting |
PUT /v1/projects/{project}/incremental-rebuild | yard settings set incremental-rebuild | yard_setting |
PUT /v1/projects/{project}/merge-trains | yard settings set merge-trains | yard_setting |
PUT /v1/projects/{project}/continue-merged | yard settings set continue-merged | yard_setting |
PUT /v1/projects/{project}/checks-while-reviewing | yard settings set checks-while-reviewing | yard_setting |
PUT /v1/projects/{project}/checks-before-submit | yard settings set checks-before-submit | yard_setting |
PUT /v1/projects/{project}/engine-sizing | yard settings set engine-sizing | yard_setting |
PUT /v1/projects/{project}/warm-hour | yard settings set warm-hour | yard_setting |
PUT /v1/projects/{project}/task-permission | yard settings set who-submits | yard_setting |
PUT /v1/projects/{project}/fixes | yard settings set fixes | yard_setting |
PUT /v1/projects/{project}/docs-excused | yard settings set docs-excused | yard_setting |
PUT /v1/projects/{project}/keep-failed-machines | yard settings set keep-failed-machines | yard_setting |
PUT /v1/projects/{project}/reviews | yard settings set reviews | yard_setting |
Keys
| Route | yard | MCP |
|---|---|---|
POST /v1/projects/{project}/fleets | yard group create | yard_agent_group_create |
GET /v1/projects/{project}/fleets | yard group list | yard_agent_groups |
POST /v1/projects/{project}/admin-key/rotate | yard project rotate-admin-key | signed-in person: a rotation stops every earlier admin key at once; Switchyard takes it only from a person signed in with admin access to the project, never from a key, the admin key itself included, so no MCP tool rotates it |
POST /v1/projects/{project}/fleets/{fleet}/rotate | yard group | yard_agent_group_key |
POST /v1/projects/{project}/fleets/{fleet}/disable | yard group | yard_agent_group_key |
POST /v1/projects/{project}/fleets/{fleet}/enable | yard group | yard_agent_group_key |
POST /v1/projects/{project}/workspaces/{workspace}/key | yard branch key | yard_task_key |
POST /v1/projects/{project}/fleets/offboard | signed-in person: it runs as part of removing a member from the organization, a person's change to its people | signed-in person: it runs as part of removing a member from the organization, a person's change to its people |
POST /v1/projects/{project}/fleets/{fleet}/revoke | yard group | yard_agent_group_key |
GET /api/orgs/{org}/keys | yard org keys | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/orgs/{org}/keys | yard org key create | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/orgs/{org}/keys/{key}/{action} | yard org key | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
The project
| Route | yard | MCP |
|---|---|---|
POST /v1/projects | yard init | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /v1/projects/{project} | yard project show | yard_whoami |
GET /v1/projects/{project}/me | yard whoami | yard_whoami |
GET /v1/projects/{project}/creation | no command: yard init waits on its own create and never reads it; yard api GET /v1/projects/{project}/creation reads it | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /v1/projects/{project}/status | yard status | yard_status |
GET /v1/projects/{project}/notifications | signed-in person: yard notifications reads your notifications of every project with your sign-in (GET /api/me/notifications); this route is the MCP sign-in's read inside one project | yard_notifications |
GET /v1/projects/{project}/spending-limit | no command: a person's yard org limit reads the organization's own limit through GET /api/orgs/{org}/billing/limit; yard api GET /v1/projects/{project}/spending-limit reads this route with the project's key | yard_spending_limit |
GET /v1/projects/{project}/queue-health | yard queue health | yard_queue_health |
PUT /v1/projects/{project}/pause | yard pause | yard_pause |
DELETE /v1/projects/{project}/pause | yard resume | yard_resume |
POST /v1/projects/{project}/copy-again | yard copy-again | yard_copy_again |
POST /v1/projects/{project}/copy-history | yard copy-history | yard_copy_history |
DELETE /v1/projects/{project}/copy-history | yard copy-history --cancel | yard_copy_history |
POST /v1/projects/{project}/engine/wake | yard engine wake | yard_wake_engine |
POST /v1/projects/{project}/feedback | yard feedback | yard_feedback |
POST /v1/projects/{project}/live | yard status --watch | internal: the live feed is a WebSocket held open for as long as one watches, which an MCP tool call cannot hold; MCP reads the same state with yard_status |
POST /v1/projects/{project}/mcp | internal: it is the MCP server's own endpoint, which an MCP client calls; yard agent setup writes that client's configuration and calls nothing | internal: it is the MCP server's own endpoint, which every MCP tool goes through |
GET /v1/projects/{project}/mcp | internal: it is the MCP server's own endpoint, which an MCP client calls; yard agent setup writes that client's configuration and calls nothing | internal: it is the MCP server's own endpoint, which every MCP tool goes through |
DELETE /v1/projects/{project}/mcp | internal: it is the MCP server's own endpoint, which an MCP client calls; yard agent setup writes that client's configuration and calls nothing | internal: it is the MCP server's own endpoint, which every MCP tool goes through |
GET /v1/projects | yard project list | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/projects/{project}/deletion | yard project deletion | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/projects/{project}/deletion | yard project delete | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
DELETE /api/projects/{project}/deletion | yard project keep | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
Setting a repository up
| Route | yard | MCP |
|---|---|---|
GET /api/github | internal: the board reads the App's name here; yard setup github reads it with the installations from /api/onboarding/github | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/onboarding/github | yard setup github | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/onboarding/repositories | yard setup repos | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/onboarding/analysis | yard setup analyze | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/onboarding/setup | yard setup apply | signed-in person: it answers to a person's own access on GitHub; it stays allowed with the person's yard sign-in, so an agent sets a repository up for its person, but no key or MCP tool does |
POST /api/onboarding/checks-on | yard setup checks-on | signed-in person: the change answers to a person's own access on GitHub, which an agent's key does not have |
Organizations
| Route | yard | MCP |
|---|---|---|
POST /api/auth/organization/create | browser only: a person makes an organization in a browser where they are signed in, however long ago, so no agent makes one its person did not ask for; yard org create and an MCP sign-in are answered approval_required with the page | browser only: a person makes an organization in a browser where they are signed in, however long ago, so no agent makes one its person did not ask for; yard org create and an MCP sign-in are answered approval_required with the page |
POST /api/auth/organization/update | yard org rename | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/auth/organization/delete | browser only: it cannot be undone, so an owner does it in a browser signed in within 15 minutes, never with a key or a yard sign-in; yard org delete prints that page | browser only: it cannot be undone, so an owner does it in a browser signed in within 15 minutes, never with a key or a yard sign-in; yard org delete prints that page |
POST /api/auth/organization/accept-invitation | yard org accept | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
POST /api/auth/organization/reject-invitation | yard org decline | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
POST /api/auth/organization/cancel-invitation | yard org withdraw | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
GET /api/orgs | yard org list | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org} | yard org show | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/teams/{org} | no command: it is the older address of GET /api/orgs/{org}, which yard org show reads; yard api sends it with a person's sign-in | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/members | yard org members | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/invitations | yard org invitations | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/invitations | yard org invite | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
GET /api/invitations | yard org invited | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/members/{member}/keys | yard org remove --keep | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
POST /api/orgs/{org}/members/{member}/role | yard org role | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
POST /api/orgs/{org}/members/{member}/remove | yard org remove | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
POST /api/orgs/{org}/leave | yard org leave | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
GET /api/orgs/{org}/teams | yard org teams | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/orgs/{org}/teams | yard org team create | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
DELETE /api/orgs/{org}/teams/{team} | yard org team delete | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
GET /api/orgs/{org}/teams/{team}/members | yard org members --team | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/orgs/{org}/teams/{team}/members | browser only: who is on a team decides who reviews what, so a person adds someone to a team or takes them off in a browser signed in within 15 minutes; no key, yard sign-in or agent does it, and yard org team add and remove are answered approval_required with the teams page | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
DELETE /api/orgs/{org}/teams/{team}/members/{member} | browser only: who is on a team decides who reviews what, so a person adds someone to a team or takes them off in a browser signed in within 15 minutes; no key, yard sign-in or agent does it, and yard org team add and remove are answered approval_required with the teams page | signed-in person: it changes the organization's people, teams or roles, which a person does themselves; no agent's key or tool may |
GET /api/orgs/{org}/ai-fixes | yard org ai-fixes | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/agent-approvals | yard org agent-approvals | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
PUT /api/orgs/{org}/agent-approvals | browser only: letting agents approve work is changed only by an owner or admin in a browser signed in within 15 minutes, so no agent turns it on for itself; yard org agent-approvals on prints that page | browser only: letting agents approve work is changed only by an owner or admin in a browser signed in within 15 minutes, so no agent turns it on for itself; yard org agent-approvals on prints that page |
GET /api/orgs/{org}/agent-policy | signed-in person: read on the organization's team page; no yard command reads it yet | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
PUT /api/orgs/{org}/agent-policy | browser only: what agents may do in an organization is changed only by an owner or admin in a browser signed in within 15 minutes, so no agent turns its own limits off; yard and MCP sign-ins are answered approval_required with the team page | browser only: what agents may do in an organization is changed only by an owner or admin in a browser signed in within 15 minutes, so no agent turns its own limits off; yard and MCP sign-ins are answered approval_required with the team page |
PUT /api/orgs/{org}/ai-fixes | browser only: AI fixes spend on the organization's bill, so a person turns them on or off in a browser signed in within 15 minutes; yard org ai-fixes on prints that page | browser only: AI fixes spend on the organization's bill, so a person turns them on or off in a browser signed in within 15 minutes; yard org ai-fixes on prints that page |
GET /api/orgs/{org}/engine-sizing | yard org engine-sizing | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
PUT /api/orgs/{org}/engine-sizing | yard org engine-sizing | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/value | yard org value | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/usage | yard org usage | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/billing | yard org billing | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/billing/runs.csv | yard org billing --csv | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
PUT /api/orgs/{org}/billing/contacts | yard org billing contacts | browser only: it changes the organization's billing, which a person who looks after billing does on the billing page, in a browser signed in within 15 minutes (yard org billing contacts prints that page); no agent's key or tool may |
GET /api/orgs/{org}/billing/limit | yard org limit | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
PUT /api/orgs/{org}/billing/limit | browser only: a spending limit is set, raised or removed only on the billing page by a person signed in in a browser in the last 15 minutes, never with a key or a yard sign-in; yard org limit set prints the link that confirms it | browser only: a spending limit is set, raised or removed only on the billing page by a person signed in in a browser in the last 15 minutes, never with a key or a yard sign-in; yard org limit set prints the link that confirms it |
POST /api/orgs/{org}/billing/limit/raise | browser only: a spending limit is set, raised or removed only on the billing page by a person signed in in a browser in the last 15 minutes, never with a key or a yard sign-in; yard org limit set prints the link that confirms it | browser only: a spending limit is set, raised or removed only on the billing page by a person signed in in a browser in the last 15 minutes, never with a key or a yard sign-in; yard org limit set prints the link that confirms it |
GET /api/orgs/{org}/billing/card | yard org card | signed-in person: it shows the card and the bill's amounts, which only the people who look after billing read; agents never read the spend, and a payment hold reaches them through yard_status and yard_spending_limit |
POST /api/orgs/{org}/billing/card | yard org card add | signed-in person: a person who looks after billing enters the card on Stripe's own page; no key opens it, yard is answered approval_required with the billing page, and the MCP server works inside one project with that project's keys |
GET /api/orgs/{org}/billing/invoices | yard org invoices | signed-in person: it shows the card and the bill's amounts, which only the people who look after billing read; agents never read the spend, and a payment hold reaches them through yard_status and yard_spending_limit |
GET /api/orgs/{org}/billing/limit/offer | signed-in person: it reads what a billing email's raise link offers, for the billing page, where the raise itself takes a browser | signed-in person: it reads what a billing email's raise link offers, for the billing page, where the raise itself takes a browser |
GET /api/orgs/{org}/audit | yard org audit | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/deleted-projects | yard org deleted | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/sso | yard org sso | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/orgs/{org}/sso/{provider}/verify | yard org sso verify | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/scim | yard org scim | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/ip-allowlist | signed-in person: a member with access to it reads it with their own sign-in, which yard holds; yard has no command for it, and yard api sends it with that sign-in | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/orgs/{org}/two-factor | yard org two-factor | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
Your account
| Route | yard | MCP |
|---|---|---|
POST /api/auth/device/code | yard login --github | internal: it is how yard login --github signs in; an MCP client signs in its own way (Claude Code and Codex) or sends a key |
POST /api/auth/device/token | yard login --github | internal: it is how yard login --github signs in; an MCP client signs in its own way (Claude Code and Codex) or sends a key |
POST /api/auth/sign-out | yard logout | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/auth/revoke-sessions | yard account sessions end --all | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
POST /api/auth/delete-user | browser only: it cannot be undone, so a person does it in a browser signed in within 15 minutes, never with a yard sign-in | browser only: it cannot be undone, so a person does it in a browser signed in within 15 minutes, never with a yard sign-in |
GET /api/me | yard whoami | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/me/emails | yard account emails | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
PUT /api/me/emails | yard account emails set | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/me/notifications | yard notifications | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
POST /api/me/notifications/seen | signed-in person: a browser marks what the bell showed; yard notifications marks nothing seen, and yard notifications read marks rows read | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
POST /api/me/notifications/read | yard notifications read | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
POST /api/me/notifications/clear | yard notifications clear | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
POST /api/me/notifications/mute | yard notifications mute | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
GET /api/me/notification-settings | yard notifications settings | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
PUT /api/me/notification-settings | yard notifications settings set | signed-in person: a person's own notifications, read and changed signed in as that person; an agent's MCP sign-in reads only its person's open reviews and tasks of one project, with yard_notifications (GET /v1/projects/{project}/notifications) |
POST /api/me/live | internal: the bell's live connection is a WebSocket held open while a page shows the bell, which a yard command or an MCP tool call does not hold | internal: the bell's live connection is a WebSocket held open while a page shows the bell, which a yard command or an MCP tool call does not hold |
GET /api/me/two-factor | browser only: a person confirms it in a browser, signed in with GitHub in the last 15 minutes; no key and no agent confirms it | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/me/agents | yard account agents | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
DELETE /api/me/agents/{agent} | yard account agents end | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
GET /api/sessions | yard account sessions | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
DELETE /api/sessions/{session} | yard account sessions end | signed-in person: it acts for a person signed in, across projects; the MCP server answers inside one project, even for an agent signed in as its person over OAuth, so organization and account actions are not tools there |
The service
| Route | yard | MCP |
|---|---|---|
GET /v1 | yard doctor | internal: a liveness answer for probes and yard doctor; an MCP session is already connected |
GET /v1/upstream | yard status | yard_status |
GET /v1/openapi.json | internal: it describes the API for machines; yard and the MCP server are two of the ways it describes | internal: it describes the API for machines; yard and the MCP server are two of the ways it describes |
<!-- end of every route -->