Skip to main content
Glama

Read a GigXchange help article

get_help_article
Read-onlyIdempotent

The full text of one official GigXchange help article, by slug from a search_help result.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesArticle slug from search_help.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is fully covered. The description's only added disclosure is that the return is the 'full text' of a single article — useful since no output schema exists, but thin beyond that.

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 filler; resource and scoping constraint appear before the sourcing detail.

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 trivial one-parameter read tool whose annotations cover the safety profile and whose description names the return content and slug source, there is little missing. Only the absence of error/not-found behavior keeps it from a top score.

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?

With one parameter at 100% schema coverage, the schema already documents the slug. The description only reinforces that the slug originates from search_help, adding no format or syntax detail beyond the schema's own description.

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 (read the full text of one help article) and scopes it to 'one official article,' which cleanly separates it from search_help and list_help_topics. It names the sibling source of the slug, though it stops short of contrasting against the other get_* retrieval tools.

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

Usage Guidelines4/5

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

The phrase 'by slug from a search_help result' establishes the required workflow precondition — you must have searched first to obtain the slug. No explicit when-not guidance or comparison to alternative retrieval tools, but the context is clear.

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