Skip to main content
Glama

Document

document
Read-onlyIdempotent

Document by name (e.g. "rfc9000", "draft-ietf-quic-transport").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
metaNo
objectsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedOutput schema / properties / meta
      Added value: +{
      +  "properties": {
      +    "limit": {
      +      "type": "number"
      +    },
      +    "next": {
      +      "type": "null"
      +    },
      +    "offset": {
      +      "type": "number"
      +    },
      +    "previous": {
      +      "type": "null"
      +    },
      +    "total_count": {
      +      "type": "number"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / objects
      Added value: +{
      +  "items": {
      +    "properties": {
      +      "abstract": {
      +        "type": "string"
      +      },
      +      "ad": {
      +        "type": "string"
      +      },
      +      "expires": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "external_url": {
      +        "type": "string"
      +      },
      +      "group": {
      +        "type": "string"
      +      },
      +      "id": {
      +        "type": "number"
      +      },
      +      "intended_std_level": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "keywords": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "note": {
      +        "type": "string"
      +      },
      +      "notify": {
      +        "type": "string"
      +      },
      +      "pages": {
      +        "type": "number"
      +      },
      +      "resource_uri": {
      +        "type": "string"
      +      },
      +      "rev": {
      +        "type": "string"
      +      },
      +      "rfc": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "rfc_number": {
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "shepherd": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "states": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "std_level": {
      +        "type": "string"
      +      },
      +      "stream": {
      +        "type": "string"
      +      },
      +      "submissions": {
      +        "items": {
      +          "type": [
      +            null,
      +            "string"
      +          ]
      +        },
      +        "type": "array"
      +      },
      +      "tags": {
      +        "items": {
      +          "type": [
      +            "string",
      +            null
      +          ]
      +        },
      +        "type": "array"
      +      },
      +      "time": {
      +        "type": "string"
      +      },
      +      "title": {
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      },
      +      "uploaded_filename": {
      +        "type": "string"
      +      },
      +      "words": {
      +        "type": "number"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / results
      Removed value: -{
      -  "description": "Array of matching documents",
      -  "items": {
      -    "properties": {
      -      "abstract": {
      -        "description": "Document abstract",
      -        "type": "string"
      -      },
      -      "name": {
      -        "description": "Document name",
      -        "type": "string"
      -      },
      -      "pages": {
      -        "description": "Number of pages",
      -        "type": [
      -          "number",
      -          "null"
      -        ]
      -      },
      -      "published": {
      -        "description": "Publication date",
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "rfc": {
      -        "description": "RFC number if applicable",
      -        "type": [
      -          "number",
      -          "null"
      -        ]
      -      },
      -      "status": {
      -        "description": "Document status",
      -        "type": "string"
      -      },
      -      "title": {
      -        "description": "Document title",
      -        "type": "string"
      -      },
      -      "type": {
      -        "description": "Document type",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
  2. Changed2 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "name": "rfc9000"
      +  },
      +  {
      +    "name": "draft-ietf-quic-transport"
      +  }
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "description": "Document response from IETF Datatracker API",
      +  "properties": {
      +    "results": {
      +      "description": "Array of matching documents",
      +      "items": {
      +        "properties": {
      +          "abstract": {
      +            "description": "Document abstract",
      +            "type": "string"
      +          },
      +          "name": {
      +            "description": "Document name",
      +            "type": "string"
      +          },
      +          "pages": {
      +            "description": "Number of pages",
      +            "type": [
      +              "number",
      +              "null"
      +            ]
      +          },
      +          "published": {
      +            "description": "Publication date",
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "rfc": {
      +            "description": "RFC number if applicable",
      +            "type": [
      +              "number",
      +              "null"
      +            ]
      +          },
      +          "status": {
      +            "description": "Document status",
      +            "type": "string"
      +          },
      +          "title": {
      +            "description": "Document title",
      +            "type": "string"
      +          },
      +          "type": {
      +            "description": "Document type",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive. The description adds no significant behavioral detail beyond what annotations provide—no mention of error handling, missing documents, response format, or relationships to other resources. Since the bar is lower with annotations, but the description contributes almost nothing, a 2 is appropriate.

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 exceptionally concise—a single sentence with examples—and every part earns its place. It front-loads the core action and immediately clarifies usage with examples. No wasted words.

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?

Despite being a simple one-parameter tool with an output schema, the description is incomplete given the rich set of sibling tools. It does not explain the scope of 'document' (e.g., IETF standards) or how it differs from 'documents_search', 'rfc', or 'wg'. An agent could easily mis-select this tool without more context. The output schema helps, but the description leaves too much ambiguity.

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?

The input schema has a single 'name' parameter with 0% description coverage. The tool description compensates well by giving concrete examples ('rfc9000', 'draft-ietf-quic-transport') and clarifying that 'name' refers to the document's identifier. This adds meaningful context beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear verb ('Document') and resource ('by name') with examples, but 'Document' is vague and could refer to any type of document. It is not a tautology, but it lacks specificity about what kind of document (e.g., RFCs, drafts) and does not differentiate from siblings like 'documents_search' or 'rfc'.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention 'documents_search' or any other sibling, nor does it give conditions for choosing 'document' over them. An agent would have no way to know if this is the right tool for a given query.

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.