Skip to main content
Glama

Get help article

get_help_article
Read-onlyIdempotent

Returns one Paidnice help article as markdown, with its title, section, last updated date and url. Read only.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "href": "<href>"
    },
    "name": "get_help_article"
  }
}

Input Schema

NameRequiredDescriptionDefault
hrefYesThe href or url of an article from search_help

Output Schema

NameRequiredDescriptionDefault
urlYes
titleYes
sectionYes
updatedYesYYYY-MM-DD
markdownYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, and the description's 'Read only' merely restates that. It adds some value by disclosing the return shape (markdown plus title, section, last updated date, url), though an output schema already exists, so it does not add meaningful behavioral context beyond structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences with the core purpose front-loaded and no filler. The trailing 'Read only' duplicates the readOnlyHint annotation and could be dropped, which keeps it just short of a 5.

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?

This is a simple single-parameter read tool with full schema coverage, complete annotations and an output schema, so return values need not be explained in prose. What remains — the verb, the resource, the format and the field list — is all stated, leaving nothing an agent needs before calling it.

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?

There is a single parameter with 100% schema description coverage, and the schema already explains that href comes from search_help results. The description adds no extra meaning about the href format, whether it accepts a full URL or a path, or what happens on an unknown href, so the baseline 3 applies.

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 states a specific verb and resource ('Returns one Paidnice help article as markdown') and names the returned fields, so an agent can tell it apart from list/search siblings. It never names search_help directly, so the differentiation from that closest sibling is only inferable from the schema's href description.

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 only implied: fetching a single article by href, contrasted implicitly with search_help. There is no explicit when-to-use or when-not statement, and the pointer to search_help for obtaining href lives in the input schema rather than the description.

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