Skip to main content
Glama

List topics

heystack_list_topics
Read-onlyIdempotent

List Heystack topic tags and how many documents use each one. Use this to find a topic slug before filtering a search. Do not use it to read a document or to search by a question.

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": "heystack_list_topics"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoHow many topics to return, from 1 to 100. Default 50.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/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, so the safety profile is fully covered by structured data. The description adds the useful disclosure that results include per-topic document counts, but says nothing about ordering, pagination behavior when the limit truncates the list, or how empty results are represented — modest added value over the annotations.

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?

Three short sentences, front-loaded with what the tool returns, then the when-to-use, then the exclusions. Every clause carries information; there is no filler or restatement of the title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-optional-parameter, read-only listing tool with no output schema, the description covers purpose, output content and routing, which is close to sufficient. The remaining gap is ordering: with a limit of up to 100 topics, an agent cannot tell whether results are the most-used topics or an arbitrary slice, which affects how it should interpret a truncated list.

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 description coverage is 100% and the single limit parameter is fully documented with its default, minimum and maximum, so the schema does the heavy lifting and a baseline 3 applies. The description deserves slight credit for framing the output as topics ranked/numbered by document usage, which is the context that makes 'limit' meaningful in the first place.

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 ("List Heystack topic tags") and adds the payload detail that matters — each tag comes with its document count. The following sentences explicitly separate it from reading documents and from question-based search, so an agent can place it among the siblings without opening the 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?

Gives an explicit positive trigger ("find a topic slug before filtering a search") and two explicit exclusions (not for reading a document, not for searching by question). It stops short of naming the concrete sibling tools to use instead, which keeps it from the top score, but the intent-level routing is unambiguous.

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