Skip to main content
Glama

Search help articles

search_help
Read-onlyIdempotent

Search the Paidnice help articles by keyword. Returns up to 10 matches, best first. Only articles containing every keyword match, so a long query can return nothing. get_help_article returns the full text. 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": {
      "query": "<query>"
    },
    "name": "search_help"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesKeywords, for example "late fee grace period"

Output Schema

NameRequiredDescriptionDefault
articlesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and non-destructive, so "Read only" adds nothing. The real value is beyond the annotations: a hard cap of 10 results, best-first ordering, and the AND-matching rule that makes over-long queries return empty. That AND semantics is the kind of behavior an agent could not infer elsewhere.

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?

Five short sentences, zero filler, all front-loaded with the action and scope before the caveat. The trailing "Read only" is mild redundancy against readOnlyHint but does not bloat the definition.

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?

For a one-parameter search tool with an output schema and full annotation coverage, this covers everything an agent needs: what is searched, result cap, ordering, failure mode, and the natural follow-up tool. Nothing material is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the schema already provides an example query, so the baseline is 3. The description earns above baseline by explaining the matching rule (every keyword must appear) and the practical consequence for long queries, which is meaning the schema does not convey.

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?

States a specific verb and resource ("Search the Paidnice help articles by keyword") and implicitly distinguishes itself from the sibling get_help_article by contrasting search with full-text retrieval. An agent can route between the two without opening either schema.

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 description makes the retrieval workflow explicit: search here, then call get_help_article for the full text. It also warns that a long query can return nothing, which tells the agent when this tool underperforms. It stops short of an explicit when-not-to-use statement or suggesting query-broadening as the remedy.

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