Skip to main content
Glama

Coverage Cat

Coverage Cat docs topic index

docs_list_topics
Read-onlyIdempotent

List Coverage Cat documentation topics from the same consumer MCP connection and return each topic's title, category, URI, MIME type, summary, and public href.

Input Schema

NameRequiredDescriptionDefault
limitNoHow many topics to return from the start of the filtered catalog. Omit it to get up to 25.
categoryNoDocs category to browse: `developers` for guides such as quickstart, auth, sandbox, and MCP setup, `api` for discovery and OpenAPI documents, `skills` for runtime skill guides, or `all`. Omit it to browse every category.

Output Schema

NameRequiredDescriptionDefault
totalYesNumber of topics in this response after limit, not the size of the whole catalog.
topicsYesTopics in catalog order.
categoryYesCategory filter that was applied.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changed
    • changedInput schema / properties / category / description
      Previous value: -"Optional docs category to browse. Use `all` for the full catalog or narrow to developers, api, or skills."New value: +"Docs category to browse: `developers` for guides such as quickstart, auth, sandbox, and MCP setup, `api` for discovery and OpenAPI documents, `skills` for runtime skill guides, or `all`. Omit it to browse every category."
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of topic entries to return from the filtered catalog."New value: +"How many topics to return from the start of the filtered catalog. Omit it to get up to 25."
    • addedOutput schema / properties / category / description
      Added value: +"Category filter that was applied."
    • addedOutput schema / properties / topics / description
      Added value: +"Topics in catalog order."
    • addedOutput schema / properties / topics / items / properties / category / description
      Added value: +"Docs category: `developers`, `api`, or `skills`."
    • addedOutput schema / properties / topics / items / properties / href / description
      Added value: +"Public web URL for the same content."
    • addedOutput schema / properties / topics / items / properties / mime_type / description
      Added value: +"Format of the resource body, such as `text/markdown` or `text/yaml`."
    • addedOutput schema / properties / topics / items / properties / summary / description
      Added value: +"What the topic covers."
    • addedOutput schema / properties / topics / items / properties / title / description
      Added value: +"Human-readable topic title."
    • addedOutput schema / properties / topics / items / properties / uri / description
      Added value: +"Resource URI to pass to docs_get_resource."
    • addedOutput schema / properties / total / description
      Added value: +"Number of topics in this response after limit, not the size of the whole catalog."
  2. Changed3 schema fields changed
    • addedInput schema / properties / category / description
      Added value: +"Optional docs category to browse. Use `all` for the full catalog or narrow to developers, api, or skills."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of topic entries to return from the filtered catalog."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "category": {
      +      "type": "string"
      +    },
      +    "topics": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "category": {
      +            "type": "string"
      +          },
      +          "href": {
      +            "type": "string"
      +          },
      +          "mime_type": {
      +            "type": "string"
      +          },
      +          "summary": {
      +            "type": "string"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "uri": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "title",
      +          "uri",
      +          "mime_type",
      +          "summary",
      +          "category",
      +          "href"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "total": {
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "category",
      +    "total",
      +    "topics"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds one useful non-annotation fact — that topics come from the same consumer MCP connection — but says nothing about pagination/ordering beyond the schema and merely restates output fields.

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, front-loaded with the verb and resource, with zero filler. Everything stated is either the action or its scope.

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?

With a low-complexity, zero-required-parameter read tool, full annotation coverage, and an output schema that already defines the return shape, the description is close to sufficient. The only missing element is routing guidance among the doc-related siblings.

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%: limit and category are fully documented in the schema, including the enum meanings and behavior when omitted. The description adds no parameter-level information beyond what the schema already provides, so the baseline of 3 applies.

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

Purpose4/5

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

The description gives a specific verb (List) and resource (Coverage Cat documentation topics) plus the fields returned, so the operation is unambiguous. It does not, however, distinguish itself from siblings docs_search and docs_get_resource, which are the obvious alternatives an agent would weigh.

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 statement of when to use this index versus docs_search or docs_get_resource, and no prerequisites. The only usage signal is the category enum in the schema, which implies browsing but is not framed as guidance relative to alternatives.

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.

Resources