Skip to main content
Glama

list_changes

Read-onlyIdempotent

List documentation proposals of a project, filtered by status (pending, accepted, rejected), with limit and cursor. Returns metadata only: id, author, dates, status, rationale and evidence previews, proposal_version, can_amend and next_cursor. Pending changes are not published knowledge; read_change returns a diff.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project_id": "<project_id>"
    },
    "name": "list_changes"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
cursorNo
statusNo
project_idYes
result_offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, non-destructive, closed-world behavior, so the description's job is to add context — and it does: results are metadata-only, previews are truncated ('evidence previews'), and next_cursor signals pagination. It stops short of stating page size defaults or what happens with an expired cursor.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences: purpose and filters first, return shape second, the caveat and sibling routing last. Every clause carries information and nothing is repeated from structured fields beyond what is needed for orientation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description usefully enumerates the returned fields (id, author, dates, status, rationale, evidence previews, proposal_version, can_amend, next_cursor), which is exactly what an agent needs to plan a follow-up call. The one gap is result_offset, which is neither in the schema nor the description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry parameter meaning. It names status, limit and cursor, but the status enum values are already in the schema and no format, default, or interaction semantics are added for limit/cursor. The result_offset parameter is never mentioned anywhere, leaving one of five params fully undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('List documentation proposals of a project') plus the scope of filtering available. It further differentiates from the sibling read_change, so an agent can select between enumeration and detail without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a clear routing rule: use this for listing proposals, use read_change for a diff, and it warns that pending changes are not published knowledge. It does not, however, address when to prefer the sibling list_changes_summary or read_changes_summary over this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources