Skip to main content
Glama

Get document

get_document
Read-onlyIdempotent

Fetch one support document owned by the authenticated Supovia organization, including its article text (capped at 20000 characters) and the contentFormat naming which syntax that text is written in (html, markdown, plain-text). A document owned by another organization returns the same bounded "not found" result. Organization ids, translator ids, deprecated slugs, embeddings, and arbitrary metadata are never returned.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNoDocument slug. Used only when documentId is not supplied.
localeNoLocale for the slug lookup (e.g. en, it, fr). Defaults to en.
documentIdNoDocument id. Preferred over slug.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes
documentYes

TDQS

A4.3/5.0
Behavior5/5

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

The annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds substantial behavioral detail beyond that: the article text is capped at 20000 characters, the contentFormat field indicates the syntax, documents from other organizations return a bounded 'not found' result, and certain fields (organization ids, translator ids, deprecated slugs, embeddings, metadata) are never returned. This enriches the agent's understanding of side effects and edge cases.

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 compact and front-loaded: the first sentence states the core action and scope, and subsequent clauses add necessary constraints and exclusions without redundancy. Every sentence serves a purpose, and there is no filler.

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

Completeness5/5

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

With an output schema present, the description need not explain return values. It covers all essential context for correct invocation: ownership scoping, the 20000-character cap, the contentFormat field, the uniform 'not found' behavior for cross-organization documents, and the fields that are never returned. This is sufficient for an agent to decide when and how to call the tool.

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% – each parameter (slug, locale, documentId) has a descriptive schema entry. The tool description adds no additional meaning about the parameters; it only references output characteristics. Since the schema already carries the parameter documentation, the description meets the baseline but does not exceed it.

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 states a specific verb ('Fetch'), a specific resource ('one support document'), and clarifies scope ('owned by the authenticated Supovia organization'). It distinguishes itself from list_documents and search_documents by specifying it retrieves a single document with full text. The phrase 'including its article text' and 'contentFormat' clearly defines what is returned.

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 implied by the purpose: retrieve one document. However, the description does not explicitly contrast with sibling tools like list_documents or search_documents, nor does it state when to prefer this tool over alternatives. It provides no exclusions or explicit when-not-to-use guidance, so it falls at the 'implied usage' level.

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

A4.2/5.0
Disambiguation3/5

Most tools have clearly distinct targets, but there is meaningful overlap among conversation/inbox tools: list_conversations, open_customer_inbox_conversation, show_customer_inbox, and show_support_overview all surface metadata-only conversation activity and could be confused when an agent needs a simple conversation listing or overview. get_conversation and get_unresolved_conversation_counts are more distinct but still add to the conversation-centric cluster.

Naming Consistency5/5

Every tool follows a snake_case verb_noun pattern: get_, list_, search_, resolve_, send_, show_, and open_. The longer names like open_customer_inbox_conversation and get_unresolved_conversation_counts are still predictable compound noun phrases, so the overall naming convention is consistent.

Tool Count5/5

With 14 tools, the server is well within the typical coherent range and the count matches its apparent scope: websites, conversations, documents, campaigns, and a few aggregate views. No tool feels purely decorative or like an unexplained duplicate.

Completeness4/5

The core support workflows are covered: listing and viewing conversations, resolving them, sending messages, and listing/searching/viewing documents and websites. The main gaps are the lack of create/update/delete operations and the absence of campaign detail/send tools, but the server appears intentionally designed as a safe, metadata-focused surface, so agents can still accomplish monitoring and limited action tasks.

Resources