Skip to main content
Glama

sync_change_request

Update a change request with the latest main content to ensure reviews reflect current documentation.

Instructions

Sync/update a change request with the latest main content

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesThe ID of the space
changeRequestIdYesThe ID or number of the change request to sync
Behavior2/5

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It only says "Sync/update" which implies mutation, but does not state whether it overwrites local changes, whether it is destructive, how it handles conflicts, or what the return value is. This is a significant gap for a mutating operation.

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?

The description is a single concise sentence that is front-loaded with the action and resource. It contains no unnecessary words and is easy to parse quickly.

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?

Given the absence of annotations and output schema, the description is too sparse. It does not explain what 'sync' entails operationally (e.g., whether it pulls changes into the change request, whether it overwrites edits, or what results are returned). The tool is a mutation with no safety annotations, so more context is needed.

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 both parameters (spaceId, changeRequestId) described individually. The description adds no additional meaning beyond the schema; it does not explain the parameters in the sync context. Baseline 3 is appropriate.

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 uses a specific verb "Sync/update" with a resource "change request" and context "with the latest main content", clearly distinguishing it from generic update tools like update_change_request. It states exactly what the tool does.

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

Usage Guidelines3/5

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

The description implies usage: use when you want to sync a change request with the latest main content. However, it does not explicitly mention when to use it versus alternatives (e.g., update_change_request or merge_change_request), nor does it provide exclusions or prerequisites.

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/lucasbenevinuto/gitbook-mcp'

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