Skip to main content
Glama

Harshith Nayaka L portfolio docs

Get doc

get_doc
Read-onlyIdempotent

One developer document in full, as markdown (the OpenAPI description is YAML).

Input Schema

NameRequiredDescriptionDefault
pathYesThe document's path, as returned by list_docs.

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 genuine value beyond that by disclosing the return format (markdown) and the notable exception that the OpenAPI document comes back as YAML, which an agent could not infer from structured 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 front-loaded sentence with no waste; the essential content and format caveat are both packed in without redundancy.

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 simple single-parameter read tool with no output schema, the description adequately conveys what is returned and in which format. Minor gaps like document size or truncation behavior remain but are not essential for correct invocation.

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 single enum parameter is fully documented, so the baseline is 3. The description's note that OpenAPI is YAML loosely corresponds to one enum value but adds little syntactic detail beyond the schema.

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 a specific verb+resource ('One developer document in full') and specifies the return format (markdown), with the OpenAPI exception noted. It implicitly distinguishes itself from the list_docs/search_docs siblings by returning a full document, though it never names them.

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?

Usage is only implied: 'in full' hints at retrieving complete content after locating a path, but there is no explicit when-to-use guidance or reference to the sibling tools. The pointer to list_docs appears only in the schema, not the description.

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.