Skip to main content
Glama

Resolve a URL to an embed in a given space

gitbook_get_embed_by_url_in_space
Read-onlyIdempotent

Resolves a URL to an embed within a specified GitBook space, enabling retrieval of embedded content by URL.

Instructions

Resolve a URL to an embed in a given space. (GET /spaces/{spaceId}/embed)

Input Schema

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

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and openWorldHint=true, covering safety and idempotency. The description adds only the HTTP method GET, which is consistent with annotations but adds minimal extra value.

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?

Two concise sentences, front-loaded with the core action. No extraneous words, ideal for quick parsing.

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?

Lacks return value information despite no output schema. For a tool that resolves a URL to an embed, the agent would need to know the structure of the embed object, which is absent. Annotations partially compensate but not fully.

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 coverage is 100% for parameter existence, but the 'body' parameter is vaguely described as 'Optional query parameters as a JSON object (e.g. { limit, page }).' No explicit properties are defined in the schema, and the description does not clarify further, leaving semantics unclear.

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 action: 'Resolve a URL to an embed in a given space.' The title reinforces this. Among many sibling tools, this is distinct for embeds, providing clear purpose.

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 on when to use this tool versus alternatives. The description lacks context on prerequisites or exclusions, leaving the agent to infer usage from the name alone.

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