Get article
reamaze_get_articleGet a single help-center article by its slug. Re:amaze REST: GET /articles/{slug}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | The article slug. |
reamaze_get_articleGet a single help-center article by its slug. Re:amaze REST: GET /articles/{slug}.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | The article slug. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already tells the agent this is a safe read, so the bar is lower. The description adds the underlying REST mapping (GET /articles/{slug}), which corroborates the read-only nature, but it says nothing about not-found behavior, auth requirements, or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with the purpose front-loaded; the REST endpoint line earns modest value as corroboration but is close to redundant filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
A one-parameter get tool is nearly self-evident and annotations cover safety, but with no output schema the description could reasonably say what the article payload contains or what happens on a missing slug. Adequate, not complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With a single parameter and 100% schema description coverage, the baseline is 4. The description reinforces that the lookup is by slug, matching the schema, though it adds no format or sourcing detail beyond it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Get a single help-center article') and the lookup key (slug). The word 'single' implicitly separates it from reamaze_list_articles, but no sibling is named explicitly, so it falls just short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this versus reamaze_list_articles, nor any prerequisite (e.g., slug discovery, auth scope). The only implied usage is 'you have a slug', which the agent must infer.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.