Skip to main content
Glama

Documents Search

documents_search
Read-onlyIdempotent

Search IETF Datatracker documents with optional filters for state (e.g. "active"), type (draft | rfc | charter), or name substring; returns document names, titles, and statuses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNodraft | rfc | charter | conflrev | …
limitNo1-1000 (default 20).
offsetNo
statesNoComma-sep state ids (e.g. "active").
name__containsNoSubstring filter on the name.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
metaNo
objectsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • removedOutput schema / properties / count
      Removed value: -{
      -  "description": "Total number of matching documents",
      -  "type": "number"
      -}
    • addedOutput schema / properties / meta
      Added value: +{
      +  "properties": {
      +    "limit": {
      +      "type": "number"
      +    },
      +    "next": {
      +      "type": "string"
      +    },
      +    "offset": {
      +      "type": "number"
      +    },
      +    "previous": {
      +      "type": "null"
      +    },
      +    "total_count": {
      +      "type": "number"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedOutput schema / properties / next
      Removed value: -{
      -  "description": "URL to next page of results",
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • addedOutput schema / properties / objects
      Added value: +{
      +  "items": {
      +    "properties": {
      +      "abstract": {
      +        "type": "string"
      +      },
      +      "ad": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "expires": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "external_url": {
      +        "type": "string"
      +      },
      +      "group": {
      +        "type": "string"
      +      },
      +      "id": {
      +        "type": "number"
      +      },
      +      "intended_std_level": {
      +        "type": "null"
      +      },
      +      "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"
      +      },
      +      "states": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "std_level": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "stream": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "submissions": {
      +        "items": {
      +          "type": [
      +            null,
      +            "string"
      +          ]
      +        },
      +        "type": "array"
      +      },
      +      "tags": {
      +        "items": {
      +          "type": [
      +            null,
      +            "string"
      +          ]
      +        },
      +        "type": "array"
      +      },
      +      "time": {
      +        "type": "string"
      +      },
      +      "title": {
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      },
      +      "uploaded_filename": {
      +        "type": "string"
      +      },
      +      "words": {
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / previous
      Removed value: -{
      -  "description": "URL to previous page of results",
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • removedOutput schema / properties / results
      Removed value: -{
      -  "description": "Array of documents matching the search criteria",
      -  "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: +[
      +  {
      +    "limit": 50,
      +    "type": "rfc"
      +  },
      +  {
      +    "name__contains": "quic",
      +    "states": "active",
      +    "type": "draft"
      +  }
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "description": "Paginated documents search results",
      +  "properties": {
      +    "count": {
      +      "description": "Total number of matching documents",
      +      "type": "number"
      +    },
      +    "next": {
      +      "description": "URL to next page of results",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "previous": {
      +      "description": "URL to previous page of results",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "results": {
      +      "description": "Array of documents matching the search criteria",
      +      "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

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and no destructive effect, so the safety profile is covered. The description adds that it is a filtered search over IETF Datatracker and returns names/titles/statuses, which is useful context about result contents. It does not contradict annotations, but it does not go beyond the safety hints with rate limits or pagination behavior, so a 3 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?

A single sentence that front-loads the verb and resource, then lists the filtering options and return fields in a compact list. There is no filler or repetition of the schema. Appropriate size for a straightforward search tool.

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

Completeness4/5

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

For a 5-parameter search with an output schema and read-only annotations, the description is mostly sufficient: it names the key filters and return payload. It is slightly incomplete in that it does not explain limit/offset pagination use or provide any usage context versus sibling tools. The presence of output schema lowers the need to spell out return values.

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?

The input schema already documents four of five parameters, including type, limit, states, and name__contains; only offset lacks description. The description reinforces which filters are for state/type/name but does not add new semantics or clarify offset/default behavior. Since schema coverage is near 80%, the description does not carry a heavy burden but also adds little beyond the 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?

The description names a concrete action ('Search IETF Datatracker documents'), a clear resource, and the optional filter dimensions (state, type, name substring). It also notes what is returned, leaving no doubt about the tool's scope. Despite a sibling named 'document', the description's resource and filter set distinguish this search tool sufficiently.

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 explicit guidance is given about when to choose documents_search over sibling tools such as document, wgs_search, or rfc. The description implies usage for searching IETF docs but does not state exclusions or alternative conditions. This is a clear gap for an agent comparing sibling tools.

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.