Skip to main content
Glama

List notes by category

list_by_category
Read-only

Return all published notes in a given top-level category. Common categories: concepts, tools, resources, case-studies, sources, workshops.

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": {
      "category": "<category>"
    },
    "name": "list_by_category"
  }
}

Input Schema

NameRequiredDescriptionDefault
categoryYesTop-level category slug, e.g. "concepts" or "workshops".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and destructiveHint=false, so safety is covered. The description adds one genuinely useful behavioral fact beyond that: only *published* notes are returned, so drafts are silently excluded. It says nothing about ordering, pagination, or what happens with an unknown category, which keeps it at adequate rather than rich.

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?

Two short sentences with no filler: the return scope comes first, followed by the actionable category vocabulary. Every clause carries information an agent needs to invoke the tool.

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 single-parameter read tool with full annotation coverage and no output schema, the description supplies the filter semantics (published-only, top-level category) and concrete argument values. Ordering and result-size behavior are the only notable omissions, and those are minor here.

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 baseline would be 3, but the description lists six concrete category slugs (concepts, tools, resources, case-studies, sources, workshops) where the schema offers only two examples and no enum. That is real value added for choosing an argument value, though it is labeled 'common' rather than exhaustive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Return all published notes') plus a scope qualifier ('in a given top-level category'), which distinguishes it from list_by_tag by axis of retrieval. It stops short of explicitly naming a sibling to contrast with, so it is clear but not maximally differentiating.

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

Usage Guidelines3/5

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

The 'top-level category' constraint implies when this tool applies versus a finer-grained lookup, and the common-category list helps an agent recognize applicable cases. However, there is no explicit when-not guidance and no mention of the obvious alternative list_by_tag, leaving the choice 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.

Resources