Skip to main content
Glama

dev_docs_read

Read-onlyIdempotent

Read dev docs. action: get | list | categories | pull (consolidated surface — same handlers as the legacy tools)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo[get] Document UUID
titleNo[get] Document title (e.g., project-a-memory.md)
actionYeswhich operation to run
searchNo[list] Search keyword in document title
categoryNo[get] Subcategory (claude, cursor, etc.) to disambiguate title [list] Subcategory filter (claude, cursor, windsurf, copilot, docs, etc.). Omit to list all dev docs. [pull] Subcategory filter. Omit to pull all docs with local_path.
content_typeNo[list] Filter by content type
include_versionsNo[get] Include version history (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
  2. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already disclose readOnly, idempotent, and non-destructive behavior. The description adds that this is a consolidated surface with the same handlers as legacy tools, which provides some behavioral context, but it does not disclose return format, pagination, or other operational details.

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 extremely concise, with two short clauses that front-load the core purpose. Every word earns its place, and there is no redundant information.

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

Completeness2/5

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

Despite having 7 parameters and multiple action modes, the description does not explain what each action does—especially 'categories' and 'pull'—or what the tool returns. The schema documents parameter details, but the tool's overall behavior and action-specific semantics remain underspecified.

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%, so parameters are fully documented in the schema. The description's action list repeats the schema enum but does not add meaning beyond what is already provided, matching the baseline for high schema coverage.

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 clearly identifies the tool's purpose as reading dev docs, with a specific verb and resource. The action list (get, list, categories, pull) adds functional scope and distinguishes this read tool from sibling write tools like dev_doc_write.

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?

The description does not state when to use this tool versus alternatives, nor does it mention that dev_doc_write should be used for modifications. Usage context is only implied by the phrase 'Read dev docs', which provides no explicit when/when-not guidance.

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