Skip to main content
Glama
Sign In
research-hub

research-hub

by WenyuChiou
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

write_topic_overview

Write a topic overview markdown file to document and organize research clusters from collected papers and notes.

Instructions

Write a topic overview markdown file 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>",
      "markdown": "<markdown>"
    },
    "name": "write_topic_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
cluster_slugYes
markdownYes
overwriteNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It only states it writes a file, but omits crucial details: the overwrite parameter's default behavior (false), whether the operation is destructive, required permissions, or any side effects. This is insufficient for safe invocation.

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?

The description is a single sentence, making it concise and front-loaded. However, it is under-specified for the tool's complexity, sacrificing completeness for brevity.

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

Completeness2/5

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

Given the tool has 3 parameters, no annotations, and an output schema that presumably explains return values, the description still lacks key contextual information: the meaning of 'cluster_slug,' the expected format of 'markdown,' and the behavior of 'overwrite.' This is insufficient for correct usage.

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?

Schema description coverage is 0%, meaning the description adds no meaning to the parameters. The parameters 'cluster_slug,' 'markdown,' and 'overwrite' are not explained at all. The description fails to clarify what each parameter represents or how to use them.

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?

The description clearly states 'Write a topic overview markdown file for a cluster,' using a specific verb (write) and resource (topic overview). It effectively distinguishes from the sibling tool 'read_topic_overview,' which is for reading.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention when not to use it, prerequisites, or any context that helps an agent decide between this and sibling tools like 'apply_cluster_summaries' or 'summarize_cluster.'

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