Skip to main content
Glama

Get Doc Snippet

get_doc_snippet
Read-only

Get one snippet with its full Markdown content and rowVersion. Set includeUsages to also list the pages embedding it — do that before deleting one. Requires project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
snippetIdYesThe public Id (Guid) of the snippet
versionIdYesThe public Id (Guid) of the doc version
includeUsagesNoAlso list the pages using this snippet (default false)
documentationIdYesThe public Id (Guid) of the documentation

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The annotation readOnlyHint:true already covers the read-only nature. The description adds extra context about rowVersion and the pre-deletion usage pattern, providing more transparency than annotations alone.

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 concise and front-loaded with the core action, followed by a helpful usage note. It is efficient and well-structured.

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?

The description is complete enough for a read-only get operation: it specifies the resource, the optional parameter, and the output content. No output schema is present, but the description indicates what will be returned.

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 descriptions cover all four parameters at 100% coverage. The description does not add significant meaning beyond the schema; it only reiterates includeUsages. Baseline 3 is appropriate since the schema handles semantics.

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 specific action: getting one snippet with full Markdown content and rowVersion. This distinguishes it from siblings like list_doc_snippets and other get_* tools, making the tool's purpose unambiguous.

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

Usage Guidelines5/5

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

It provides explicit guidance on when to set includeUsages (before deleting a snippet) and notes that project context is required. This is actionable and helps the agent decide when to use this tool versus 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.

TDQS

A3.9/5.0
Disambiguation4/5

The tools are mostly distinct with clear descriptions. Some pairs like get_header_policies vs get_resolved_headers or get_environment_verification vs get_monitoring_sync_status could be slightly confusing, but the descriptions clarify scope and purpose.

Naming Consistency5/5

All tools follow a consistent snake_case verb_noun pattern (get_, list_, create_, update_, manage_, etc.). Even the few bare verbs like 'search' and 'set_context' are consistent with the naming scheme.

Tool Count1/5

With 165 tools, the server is extremely heavy. This far exceeds the 'too many' threshold of 25+, making it difficult for an agent to navigate and select the right tool efficiently.

Completeness5/5

The tool surface covers a very broad API lifecycle domain: specs, environments, test cases, monitors, mock servers, security, governance, documentation, and team management. Read and write operations are present across most areas, with no obvious missing core functionality.

Resources