Skip to main content
Glama

Create change request

gitbook_create_change_request
Destructive

Create a new draft change request (branch) in a space. Safe: creates a draft; publishes nothing. GitBook REST: POST /spaces/{spaceId}/change-requests.

Input Schema

NameRequiredDescriptionDefault
spaceIdYesThe space id.
subjectNoA title/subject for the change request.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

B3.2/5.0
Behavior1/5

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

Annotations declare destructiveHint=true, yet the description asserts 'Safe: creates a draft; publishes nothing.' That directly negates the structured safety signal the agent relies on, which is a contradiction rather than added context. Useful details (no publish, POST endpoint) do not offset telling the agent the opposite of what the annotation says.

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?

Three short, front-loaded sentences with no filler; the core effect is stated first and the REST endpoint is appended. The 'Safe' framing occupies space but misleads, which is a small structural cost rather than verbosity.

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?

For a two-parameter creation tool with no output schema and an annotation set that the description partly conflicts with, the definition is adequate on mechanics but silent about the return value (the created change request id) and about access requirements, leaving real gaps.

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 100%, so both spaceId and subject are already documented in the schema; the description only echoes 'in a space' and says nothing about subject. Baseline 3 applies when the schema carries parameter semantics.

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?

States a specific verb and resource ('Create a new draft change request (branch)') plus the scope ('in a space'), and the parenthetical '(branch)' disambiguates it from siblings like gitbook_update_change_request and gitbook_list_change_requests. An agent can select it correctly without opening the schema.

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 clause 'creates a draft; publishes nothing' implies when this is appropriate (proposing edits without touching published content), but there is no explicit when-to-use or when-not-to-use guidance relative to siblings such as update_change_request or direct page editing. Usage is inferable rather than stated.

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.