Skip to main content
Glama
Sign In
research-hub

research-hub

by WenyuChiou
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

list_topic_notes

Retrieve existing sub-topic notes for a given cluster. Provide a cluster slug to access its associated notes.

Instructions

List existing sub-topic notes for a cluster.

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": {
      "cluster_slug": "<cluster_slug>"
    },
    "name": "list_topic_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
cluster_slugYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden. It only states the function but does not disclose idempotency, side effects, or that it is a read-only operation. Minimal behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, efficient but too brief, missing essential details. It is front-loaded but at the expense of completeness.

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

Completeness3/5

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

While the tool has only one parameter and an output schema exists, the description lacks context about how to find the cluster slug or what to expect in return. Adequate when combined with other tools, but incomplete standalone.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The parameter 'cluster_slug' has no description in the schema, and the tool description does not explain its meaning, format, or how to obtain it. With 0% schema coverage, the description adds no value.

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?

The description clearly states it lists sub-topic notes for a cluster, with a specific verb and resource. It distinguishes from siblings like build_topic_notes (creates) and list_clusters (lists clusters). However, 'sub-topic notes' could be more precise.

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

Usage Guidelines2/5

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

No guidance on when to use this tool vs alternatives, no prerequisites or exclusions. The description fails to provide context for appropriate use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools