Skip to main content
Glama

Read a FlightByte docs page

get_doc_page
Read-onlyIdempotent

Fetch one FlightByte documentation page as Markdown from a docs path or search result URL to look up specific API details without an API key.

Instructions

Fetch one FlightByte documentation page as Markdown. Accepts a URL from search_docs (anchors are ignored) or a path such as "/docs/webhooks", "/docs/reference/subscriptions/create-subscription", "/guides/verifying-webhook-signatures" or "/glossary/flight-phase". "/docs" is the introduction, with links to every page. Works without an API key.

Input Schema

NameRequiredDescriptionDefault
pathYesDocs path or URL, e.g. "/docs/errors" or "https://flightbyte.dev/docs/webhooks#verifying-signatures".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent and open-world, so the safety profile is covered. The description adds genuinely new behavioral facts: no API key required, anchors are stripped, and "/docs" returns the full page index. It does not say what happens on an invalid path, but the added auth and normalization details are real 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?

Three tight sentences, front-loaded with the core action and output format, followed by input forms and the useful "/docs" entry-point hint. The example paths are long but each illustrates a different accepted prefix.

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

Completeness5/5

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

For a single-parameter read tool with no output schema, the description covers what it returns (Markdown), where valid inputs come from, and the auth situation. Nothing an agent needs in order to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with one required string, so the baseline is 3. The description goes beyond the schema by explaining that anchors in URLs are ignored and by listing multiple accepted path shapes (docs, guides, glossary), which clarifies that the parameter is not restricted to /docs paths.

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 ("Fetch one FlightByte documentation page") plus the return format (Markdown), which is information the name alone does not convey. It also implicitly separates itself from search_docs by framing itself as the page reader rather than the finder.

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

Usage Guidelines4/5

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

Tells the agent exactly what inputs are valid — a URL from search_docs with anchors ignored, or a path — and enumerates representative path families including the docs root. It does not explicitly say when to prefer search_docs over this tool, so routing is inferred rather than stated.

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