Skip to main content
Glama

List Change Request Documents

list_change_request_documents
Read-onlyIdempotent

Use this when working with RetailHardHat documents records in the connected organization. Read change_request document metadata. MCP approval requirements are configurable by the organization administrator; business workflow approvals always apply.

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": {
      "changeRequestId": "<changeRequestId>"
    },
    "name": "list_change_request_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
searchNo
changeRequestIdYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is clear. The description adds that metadata is read and mentions approval requirements, but it does not explain pagination behavior or how the limit/offset parameters affect results.

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

Conciseness3/5

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

The description is short, but the first sentence is generic filler and the approval sentence is boilerplate that does not help with this specific read operation. The most useful information is not front-loaded.

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

Completeness3/5

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

An output schema exists, so return values need not be described, and annotations cover safety. However, the description leaves key gaps around parameter meaning, pagination, and differentiation from the sibling read tool.

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

Parameters2/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 explain the four parameters. It does not explain limit, offset, or search at all, and only implicitly references changeRequestId through the resource name.

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

Purpose4/5

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

The description states a specific resource and operation: reading change_request document metadata. However, it does not clearly distinguish listing documents from the sibling read_change_request_document tool, and the opening sentence is generic.

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

Usage Guidelines2/5

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

It says to use this when working with RetailHardHat document records in the connected organization, which is too broad to guide tool selection. It never mentions when to use this instead of read_change_request_document, list_change_requests, or other document tools.

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