get_use_case
One use case by id, with its reference, title, actor, other actors, goal, trigger, conditions, frequency, priority, status and its steps in order, each in the main flow or in an alternate or exception flow that leaves a main step.
Return one use case with its steps: the reference, the title, the persona who acts and the other actors, the goal, the trigger, what must be true before and after, how often it happens, priority and status, and steps in order. Each step says what the actor does and what the system does in reply, which flow it belongs to (main, alternate or exception), and, for a branch, its flow_label (such as 2a) and the main step it leaves in branches_from, numbered from one. Walk the main flow first and then each branch when you implement or test a use case, so the happy path and every way it goes differently are both covered.
A use case of a project the token may not see, or a draft read through a guest token, is unknown rather than forbidden.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same actions as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
use_case_id*stringUUID of the use case to fetch.
What it returns
{ "data": { "id": "e6f7a8b9-c0d1-4e2f-9a3b-4c5d6e7f8091", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "number": 4, "reference": "CRM-UC-4", "title": "Redeem a voucher at checkout", "actor_persona_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81", "actor_persona_name": "Nadeesha, the returning shopper", "secondary_actors": ["Payment provider"], "goal": "Pay less for the basket with a voucher the member holds", "trigger": "The member opens the checkout with a voucher in their wallet", "preconditions": "<p>The member is signed in and the basket is not empty.</p>", "postconditions": "<p>The voucher is marked used and the order carries the discount.</p>", "frequency": "A few hundred times a day in a campaign week", "priority": "must", "status": "approved", "steps": [ { "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "use_case_id": "e6f7a8b9-c0d1-4e2f-9a3b-4c5d6e7f8091", "position": 0, "flow": "main", "flow_label": null, "actor_action": "The member opens the checkout", "system_response": "The system shows the basket and the vouchers in the wallet", "branches_from": null }, { "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e", "use_case_id": "e6f7a8b9-c0d1-4e2f-9a3b-4c5d6e7f8091", "position": 1, "flow": "main", "flow_label": null, "actor_action": "The member picks a voucher", "system_response": "The system applies the discount and shows the new total", "branches_from": null }, { "id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f", "use_case_id": "e6f7a8b9-c0d1-4e2f-9a3b-4c5d6e7f8091", "position": 2, "flow": "exception", "flow_label": "2a", "actor_action": "The member picks a voucher that expired", "system_response": "The system refuses it, says why and keeps the total", "branches_from": 2 } ], "position": 3, "version": 0, "approved_at": "2026-11-05T15:00:00+00:00", "approved_revision_id": null, "created_at": "2026-10-28T09:20:00+00:00", "updated_at": "2026-11-05T15:00:00+00:00" }}How it fails
RESOURCE_NOT_FOUNDunknown use_case_id, a use case of a project outside the token's scope or the person's visibility, or a draft read through a guest token.
TOKEN_MISSING_ABILITYtoken lacks use-case:view.
How is this guide?
Last updated on