Skip to main content
Glama

Get change request semantic changes

gitbook_get_change_request_changes
Read-onlyIdempotent

Retrieve the semantic changes of a change request to review content modifications before approval.

Instructions

Get change request semantic changes. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/changes)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesPath parameter: spaceId.
changeRequestIdYesPath parameter: changeRequestId.
bodyNoOptional query parameters as a JSON object (e.g. { limit, page }).
Behavior2/5

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

Annotations already provide readOnlyHint, idempotentHint, and openWorldHint, but the description adds no extra behavioral context. It does not discuss pagination, limits, or any side effects, even though the body parameter suggests possible query parameters.

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

Conciseness4/5

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

The description is very concise with one sentence and the endpoint. It is front-loaded and contains no fluff. However, it could include more useful information without becoming verbose.

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?

The tool has no output schema, but the description does not explain what 'semantic changes' entails or the structure of the response. Given the complexity of the concept, more context on return format would be beneficial.

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 coverage is 100% with descriptions for all three parameters. The description adds no additional meaning beyond what the schema already provides. The baseline of 3 applies due to high coverage.

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 clearly states the verb 'Get' and the resource 'change request semantic changes', and includes the API endpoint. Among siblings, it distinguishes itself by specifying 'semantic changes' as opposed to other change request details.

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?

No guidance is provided on when to use this tool versus alternatives. The description only states what it does, without any when-not-to or alternative tool references.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/HoYongJin/gitbook-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server