Skip to main content
Glama

List Documents

list_documents
Read-onlyIdempotent

Documents within a docket (or matching a query). Returns title, type (Rule / Proposed Rule / Notice / Supporting), comment counts, posted date, document ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoFree-text query across documents
docket_idNoFilter to one docket
page_sizeNo5-250
page_numberNo1-based page
document_typeNoRule | Proposed Rule | Notice | Supporting & Related Material | Other

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYesCurrent page number
totalYesTotal number of documents matching the query
resultsYesList of document objects
returnedYesNumber of results in this response
page_sizeYesNumber of results per page
total_pagesYesTotal number of pages

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "docket_id": "EPA-HQ-OAR-2021-0317",
      +    "document_type": "Proposed Rule"
      +  },
      +  {
      +    "page_size": 100,
      +    "query": "greenhouse gas"
      +  }
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "page": {
      +      "description": "Current page number",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "page_size": {
      +      "description": "Number of results per page",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "results": {
      +      "description": "List of document objects",
      +      "items": {
      +        "additionalProperties": true,
      +        "properties": {
      +          "id": {
      +            "description": "Document ID",
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "type": {
      +            "description": "Resource type",
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "returned": {
      +      "description": "Number of results in this response",
      +      "type": "integer"
      +    },
      +    "total": {
      +      "description": "Total number of documents matching the query",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "total_pages": {
      +      "description": "Total number of pages",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "total",
      +    "page",
      +    "page_size",
      +    "total_pages",
      +    "returned",
      +    "results"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds transparency about the output contents (title, type, comment counts, posted date, document ID) without duplicating annotations. It does not contradict any annotation and provides useful behavioral context.

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 two sentences long, front-loaded with the core purpose, and immediately lists return fields. Every word contributes value; there is no redundant or filler content.

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?

Given the rich input schema (all parameters documented), output schema availability, and annotations covering safety, the description is sufficiently complete for a listing tool. It covers the operation's scope and return values, leaving no critical gaps for an agent to select and invoke correctly.

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?

Schema description coverage is 100%, so each parameter already has a clear description. The tool description only reiterates the docket/query scoping and does not add new semantic detail such as pagination behavior, filtering nuances, or defaults beyond what the schema provides. This matches the baseline for full schema coverage.

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 tool lists documents within a docket or matching a free-text query, and enumerates the returned fields. This distinguishes it from sibling tools like get_comment or search_dockets by focusing on the document entity and its scoping options.

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

Usage Guidelines3/5

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

The description implies usage context by mentioning docket or query-based retrieval, but does not explicitly contrast with alternatives such as search_dockets or get_docket. The agent must infer when to prefer this tool over others based on the resource type, and no exclusionary guidance is provided.

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.