Skip to main content
Glama

Product help

product_help
Read-only

How the TRACKER ITSELF works — not what is in anybody's project: what a feature does, where it is on the screen, who may use it, and what the product does not do. Use it when the person asks about the tool ('how do sprints work here', 'where do I switch on due reminders', 'can a wiki page be restricted') rather than about their work. Pass the person's question as 'query', in their own words and language: it answers the few topics that hold those words, each with the paragraphs where they stand ('passages'). Pass 'topic' (an id from a topic found, e.g. 'sprints') to read that topic whole. With neither it lists the topics. Buttons and menu items are quoted in «…» in the person's interface language — repeat them as given. 'availability' is set when the feature is switched off for this company: say that first. The text is the whole of what the help says; what it does not say, say it does not cover — do not fill it in from other trackers, and do not answer a question about the product from the project's wiki.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
queryNoThe question in the person's own words, any language, e.g. 'how do I start a sprint'.
topicNoA topic id, e.g. 'sprints', to read that topic whole.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / query
      Added value: +{
      +  "default": null,
      +  "description": "The question in the person's own words, any language, e.g. 'how do I start a sprint'.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedInput schema / properties / topic / description
      Previous value: -"A topic id, e.g. 'sprints'. Leave out for the list."New value: +"A topic id, e.g. 'sprints', to read that topic whole."
  2. Added

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnly/openWorld annotations, it discloses response shape (matching topics with 'passages'), the effect of each parameter combination (topic alone reads whole; neither lists topics), the meaning of the 'availability' field for disabled features, and the «…» quoting convention for UI labels. It also sets a firm behavioral boundary: do not extrapolate beyond what the help says.

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?

Purpose is front-loaded, then usage, then parameters, then output conventions — a sensible order with no filler sentences. It is dense and somewhat run-on, packing several constraints into long clauses, which costs a little readability.

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?

With no output schema, the description carries the burden of explaining returns and does so: passages per topic, availability flags, quoted UI labels, and the listing default. Nothing an agent needs to call it correctly or interpret results 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%, so the schema already documents both params; the description still adds real semantics — query should be in the person's own words and language and is matched word-wise, topic must be an id obtained from a previously found topic, and the neither-params fallback lists topics. That is interaction meaning the schema does not carry.

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 subject and scope: 'How the TRACKER ITSELF works — not what is in anybody's project', enumerating what it covers (feature behavior, location on screen, permissions, non-features). This cleanly distinguishes it from project-content siblings such as the project wiki, which it explicitly names as out of scope.

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

Usage Guidelines5/5

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

Gives concrete trigger examples ('how do sprints work here', 'where do I switch on due reminders') and the exclusion condition ('rather than about their work'), plus a closing rule not to answer product questions from the project's wiki. The agent knows both when to call it and when not to.

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