Skip to main content
Glama

Find SuperCatch help

supercatch_get_help_resource
Read-onlyIdempotent

Resolve a known help topic to its public SuperCatch page. Use when a navigation link is needed for buying, selling, shipping, returns or assistant setup. This returns a page link, not searched documentation excerpts or API schemas. Returns a public help or documentation URL as text; topic uses the advertised enum. Public; no sign-in required. Read-only; no account or order changes. A missing topic returns a tool error; an unrecognized topic resolves to general help.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "topic": "help"
    },
    "name": "supercatch_get_help_resource"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYesPublic help or documentation topic.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered; the description still adds real value by stating the return type (a public URL as text), that no sign-in is required, and the two distinct failure behaviors — a missing topic raises a tool error, an unrecognized topic falls back to general help.

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?

The purpose is front-loaded and every subsequent sentence carries a distinct fact (return shape, auth, error semantics). The one low-value clause is "topic uses the advertised enum," which duplicates the schema and could be dropped without loss.

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, read-only lookup with no output schema, the description covers what is returned, that it is public, and how errors versus fallbacks behave. Nothing an agent needs to invoke it correctly is missing.

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 coverage is 100% and the single parameter carries a 16-value enum, so the schema already fully documents the input. The description only says the topic "uses the advertised enum," which restates structured data rather than explaining how to choose among the values.

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 opens with a specific verb+resource: "Resolve a known help topic to its public SuperCatch page." It then draws an explicit boundary against the closest functional siblings by stating it returns "a page link, not searched documentation excerpts or API schemas," which separates it from supercatch_search_public_docs and supercatch_get_api_catalog.

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?

It gives a clear trigger condition: "Use when a navigation link is needed for buying, selling, shipping, returns or assistant setup," plus a negative condition excluding search-excerpt and API-schema use cases. It stops short of naming the specific alternative tools an agent should pick instead, leaving that inference to the reader.

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