Skip to main content
Glama

get_research_topic_tool

Read-only

Fetches documented plot or method topic details and citations by topic ID, so researchers can review references before planning analysis without analyzing data.

Instructions

Read a documented plot/method topic and citations; does not analyse data.

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": {
      "topic_id": "<topic_id>"
    },
    "name": "get_research_topic_tool"
  }
}

Input Schema

NameRequiredDescriptionDefault
topic_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/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 the safety profile is covered. The description's 'does not analyse data' adds modest value by clarifying the output is documentation text rather than computed results, but it says nothing about behavior on an unknown or invalid topic_id.

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?

A single compact sentence with the core action front-loaded and no redundant phrasing. It is efficient, bordering on under-specified rather than verbose.

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?

An output schema exists, so return values needn't be explained, and this is a simple read-only single-parameter tool. Still missing are where topic_id comes from and failure behavior, which matter for correct invocation from a cold start.

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

Parameters2/5

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

Schema description coverage is 0% and the single parameter topic_id receives no explanation in the description — no format, no provenance, no note about what happens if it doesn't exist. The parameter name is largely self-explanatory, but the definition does not compensate for the undocumented schema.

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 concrete verb ('Read') and resource ('documented plot/method topic and citations'), which is far more specific than the tool name alone. It also scopes the tool negatively ('does not analyse data'), though it never names the sibling (list_research_topics_tool) that supplies topic IDs.

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?

Usage is implied: fetch one documented topic by ID. The clause 'does not analyse data' functions as a when-not hint, steering analysis requests elsewhere, but no explicit alternative tool or prerequisite is given (e.g., get topic_id from list_research_topics_tool first).

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