Skip to main content
Glama

fetch_qencode_doc

Read-onlyIdempotent

Read the full content of a Qencode knowledge-base resource by URI.

Works for every URI returned by `search_qencode_docs` — recipes, best
practices, storage, gotchas, error codes, and the schema digest. Call
this after `search_qencode_docs` (or with a known `qencode://...` URI)
whenever you need the full markdown or JSON of a recipe or reference doc.

Args:
    uri: a `qencode://...` URI from a `search_qencode_docs` hit.
        Examples:
          - qencode://recipe/hls_abr
          - qencode://docs/best-practices
          - qencode://docs/storage
          - qencode://docs/error-codes
          - qencode://schema/digest

Returns:
    A dict with `uri`, `mime_type`, and `content` (the full markdown or
    JSON, depending on the doc). On unknown URI, returns
    `{"error": "...", "available_uris": [...]}` listing the URIs you can
    try instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriNo
errorNo
titleNo
contentNo
mime_typeNo
available_urisNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and non-open-world, so the safety profile is covered. The description adds real value beyond that by disclosing the success return shape and the failure behavior (unknown URI returns an error with an `available_uris` list), which is not in the annotations.

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?

Front-loaded with the core purpose in the first sentence, then usage, args, and returns in a scannable structure. The example list and Returns block are slightly verbose, though the examples do earn their place given the 0% schema coverage.

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 an output schema and rich annotations, this is complete: URI format, valid value sources, examples, and error recovery path are all present. Nothing an agent needs to invoke it correctly is missing.

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

Parameters5/5

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

Schema description coverage is 0% for the single `uri` parameter, so the description carries the burden — and it does, giving the format, the source of the URI, and five concrete examples across resource types. This fully compensates for the empty schema.

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 (Read) and resource (Qencode knowledge-base resource by URI), and immediately distinguishes itself from search_qencode_docs by positioning itself as the full-content fetch. An agent can tell it apart from the sibling search tool from the first sentence.

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

Usage Guidelines5/5

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

Explicitly says to call it after `search_qencode_docs` or with a known `qencode://...` URI, and enumerates the doc categories it covers (recipes, best practices, storage, gotchas, error codes, schema digest). The when-to-use and the relationship to the alternative search tool are both 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.