Skip to main content
Glama

Harshith Nayaka L portfolio docs

List docs

list_docs
Read-onlyIdempotent

Every developer document on the site: its path, title and what it covers, optionally narrowed to a topic. Read one with get_doc.

Input Schema

NameRequiredDescriptionDefault
queryNoOnly documents whose title or summary mention this, e.g. "auth" or "MCP". Omit for every document.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and closed-world, so the safety profile is covered. The description adds genuinely new context: the tool returns the complete set of site documents (implying no pagination or partial results) along with path, title, and summary fields, which tells the agent what to expect in the payload.

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?

Two short sentences; the scope and payload come first, then the routing hint. No redundancy, nothing to trim.

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 single-parameter, zero-required list tool with no output schema, the description covers scope, return fields, filtering, and the follow-up read path. The one gap is sibling differentiation against search_docs, which matters for correct tool selection.

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 coverage is 100% and the 'query' parameter already documents substring matching against title or summary, with examples and omit behavior. The description's "optionally narrowed to a topic" restates that at a coarser grain without adding syntax or matching-rule detail, so baseline 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?

States the resource (every developer document on the site) and the returned fields (path, title, what it covers), plus the optional narrowing — an agent knows exactly what comes back. It explicitly distinguishes itself from get_doc ("Read one with get_doc") but says nothing about search_docs, which is the sibling most likely to be confused with the 'query' narrowing behavior.

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?

"Read one with get_doc" gives one clear routing rule to an alternative, and "Omit for every document" hints at the enumerate-everything use case. But the closest alternative, search_docs, is never mentioned, leaving the agent to infer whether topical narrowing here or a search call is the right choice.

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.