READ

list_glossary_terms

Paginated list of the words a project agrees on, each with its definition, other names, related terms, source and review status, narrowed by status or search words.

Return the glossary of one project in the project's order: the words the analyst wrote down with one definition each, the other names they go by, the terms they lean on, where the definition comes from and where each stands in its review. Read it before drafting a story, a requirement, a rule or a test, so you write in the project's own words rather than your own, and read the definition of any word the brief uses in a way you did not expect.

Narrow with status (draft, in_review, approved or deprecated) and search (words in the term, an alias or the definition). A guest token reads the approved terms only, whatever status asks for.

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Runs the same action as

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

Arguments

project_id*string

UUID of the project whose glossary to list.

statusstringoptional

Narrow to one status.

draftin_reviewapproveddeprecated
searchstringoptional

Words the term, an alias or the definition must contain.

limitintegeroptional

Terms per page (1..100, default 25).

min1max100
pageintegeroptional

1-indexed page number.

min1

What it returns

{  "data": [    {      "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "term": "Branch",      "definition": "<p>One physical shop of the client, with its own stock, staff and opening hours.</p>",      "aliases": ["Site", "Location"],      "related_term_ids": ["e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81"],      "source": "Client operations manual, 2025 edition",      "status": "approved",      "position": 0,      "created_at": "2026-10-20T09:20:00+00:00",      "updated_at": "2026-10-27T11:30:00+00:00"    }  ],  "meta": {    "page": 1,    "limit": 25,    "total": 1,    "has_more": false  }}

How it fails

VALIDATION_FAILED

status is not one of the four statuses, or search is longer than 120 characters.

RESOURCE_NOT_FOUND

unknown project_id, or a project outside the token's scope or the person's visibility.

TOKEN_MISSING_ABILITY

token lacks glossary:view-any.

How is this guide?

Last updated on