Skip to main content
Glama

lookup_help_topic

Read-onlyIdempotent

Searches Onplana's product help catalog and returns NAVIGATION PATHS: where a page, tab or project view lives, so paths do not have to be guessed. It answers "where is X" and "what does role Z do" for a specific page, tab or feature. It returns no article text, so it cannot say how a feature is used or which of its settings exist; search_docs returns the step-by-step article body that covers those. Takes a short keyword phrase as query (e.g. "rate cards", "goals", "permissions matrix"); empty returns every page available to the caller. Results are auto-filtered to the caller's org role, so they never include pages the user cannot reach. Each page comes with reach, the clicks that open it starting from the sidebar (for Import: the sidebar item, and the menu on the New Project button of the Projects page); routes are not returned, because a person clicks rather than types an address. SCOPE: this catalog covers navigation (pages and project views), the buttons, tabs and menus on the Projects, Issues, Goals and Workflows pages, and the project overflow menu, which is where export lives. It is still not the full set of available actions, so an empty result means nothing in the catalog matched, which is not evidence that the capability is missing; describe_capabilities is the authoritative list of what is actually callable, including categories not yet loaded. Export-shaped queries also return an exportNote stating plainly which outbound formats exist and which do not.

Input Schema

NameRequiredDescriptionDefault
queryNoOptional keyword(s) to filter by. Substring-matched against page labels, descriptions, sections, paths, and project-tab names. Omit to list every page available to this caller.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), yet the description adds substantial context beyond them: results are auto-filtered to the caller's org role, routes are deliberately omitted because users click rather than type, export-shaped queries return an `exportNote`, and every page carries a `reach` click path. This is exactly the kind of behavioral detail annotations cannot express.

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 and the sibling distinction are front-loaded, and every section carries information, but the text is dense with parentheticals (the Import path explanation in particular) that slow scanning. Slightly tighter phrasing would preserve the content with less reading load.

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?

There is no output schema, and the description compensates fully: it names the returned structure (navigation paths plus `reach` clicks) and the `exportNote` on export-shaped queries, and clarifies scope coverage and the meaning of empty results. An agent has everything needed to call and interpret this tool.

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 single optional `query` parameter is already documented as substring-matched against labels, descriptions, sections, paths and tab names. The description adds value with concrete example values ("rate cards", "goals", "permissions matrix") and the empty-returns-every-page semantics, which goes slightly beyond the schema baseline.

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 ("Searches Onplana's product help catalog and returns NAVIGATION PATHS") and immediately scopes what it covers, down to the field it returns (`reach`). It explicitly distinguishes itself from `search_docs` (article body) and `describe_capabilities` (authoritative capability list), so an agent can route 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 Guidelines5/5

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

Explicit when-to-use ("where is X", "what does role Z do") and when-not ("cannot say how a feature is used or which of its settings exist"), each paired with the named alternative. It also spells out the empty-result condition and warns that an empty result is not evidence a capability is missing, pointing at `describe_capabilities` instead. Nothing is left to inference.

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.