`get_vouchers_procedure_catalog`

Read-only

Calls GET /api/vouchers/procedure-catalog as the signed-in person · REST reference

Procedure-catalog reference rows and their distinct dimension values

The species / procedure / sex rows the portal drives its selects from, each carrying the voucher face-value cap for that combination. Alongside the rows the response repeats the DISTINCT values of each dimension in catalog order, so a select can be populated without the caller de-duplicating. Declared before /{id} so the literal path is not captured as a voucher id. Reference data — authenticated, but not org-scoped and not permission-gated. This endpoint CANNOT answer 500: every failure, including a DAL outage, is answered 503 with a fixed message so the portal can fall back to a disabled select instead of a broken page.

Arguments

Argument	Type		Description
`includeInactive`query	"true"		Compared against the exact string 'true'. Any other value — including 1, yes or TRUE — returns launched rows only.

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_vouchers_procedure_catalog",
    "arguments": {}
  }
}

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The catalog and its de-duplicated dimension values.

json

{
  "entries": [
    {
      "active": true,
      "id": "string",
      "maxPayout": 1,
      "procedure": "string",
      "sex": "string",
      "species": "string",
      "currency": "string",
      "displayName": "string"
    }
  ],
  "procedures": [
    "string"
  ],
  "sexes": [
    "string"
  ],
  "species": [
    "string"
  ]
}

Fields

Field	Type	Description
`entries`	array of object
`entries[].active`	boolean
`entries[].currency`	string \| null
`entries[].displayName`	string \| null
`entries[].id`	string
`entries[].maxPayout`	integer	Voucher face-value cap in CENTS.
`entries[].procedure`	string
`entries[].sex`	string
`entries[].species`	string
`procedures`	array of string	Distinct `procedure` values across `entries`, in catalog order.
`sexes`	array of string	Distinct `sex` values across `entries`, in catalog order.
`species`	array of string	Distinct `species` values across `entries`, in catalog order.

When it fails

A failed call returns isError: true with the API's message as text.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json

{
  "name": "get_vouchers_procedure_catalog",
  "description": "GET /api/vouchers/procedure-catalog — The species / procedure / sex rows the portal drives its selects from, each carrying the voucher face-value cap for that combination. Alongside the rows the response repeats the DISTINCT values of each dimension in catalog order, so a select can be populated without the caller de-duplicating. Declared before `/{id}` so the literal path is not captured as a voucher id. Reference data — authenticated, but not org-scoped and not permission-gated. This endpoint CANNOT answer 500: every failure, including a DAL outage, is answered 503 with a fixed message so the portal can fall back to a disabled select instead of a broken page.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "includeInactive": {
        "type": "string",
        "description": "Compared against the exact string 'true'. Any other value — including 1, yes or TRUE — returns launched rows only."
      }
    }
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  }
}