Skip to main content
Glama

contracts: GET /api/contracts/:contractId/documents/:documentId/redline-comments

get_contracts_by_contractId_documents_b_cd73216c02e24e786e583056
Read-onlyIdempotent

GET /api/contracts/:contractId/documents/:documentId/redline-comments. GET /api/contracts/:contractId/documents/:documentId/redline-comments. Operation ID: cd73216c02e24e786e583056; describe_operation provides native request schemas.

Input Schema

NameRequiredDescriptionDefault
queryNo
paramsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.2/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so safety is covered elsewhere. The description adds nothing beyond that – no note on pagination, comment shape, permissions, or what happens with a missing documentId.

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

Conciseness2/5

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

Two nearly identical sentences with zero added information – the duplication is pure waste, and the remaining Operation ID sentence is boilerplate that belongs in metadata, not prose.

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

Completeness2/5

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

No output schema and two undocumented parameters mean the description carries the burden, yet it supplies no return-shape, error, or usage context. For a nested read endpoint in a crowded tool family this is inadequate.

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%, but the duplicated path template does at least map the two params (contractId, documentId) to their position in the URL, giving some semantic grounding. It still says nothing about format, length limits, or whether query filters are supported.

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

Purpose2/5

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

The description only restates the title/endpoint path twice ('GET /api/contracts/:contractId/documents/:documentId/redline-comments') without naming the resource in plain language or saying what a redline comment is. It adds no differentiation from the very similar sibling 'get_contracts_by_contractId_documents_b_c29ef566cda0732b5952b9ec', so an agent must infer the difference from the ID suffix alone.

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?

There is no statement of when to call this instead of the many neighboring contracts/documents tools. The only routing hint is 'describe_operation provides native request schemas', which defers rather than guides.

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