Skip to main content
Glama

api_reference

Look up Chosŏn API data formats, fit settings, results JSON, simulator/search fields, and error details before calling the API or when a request format is unclear.

Instructions

The full Chosŏn API reference: data formats for every module, fit settings, the results JSON, every simulator and search with its fields, errors. Read it before call_api or when a format is unclear.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

No annotations are supplied, but the tool takes zero parameters and is evidently a documentation read, so the destructive/mutating risk surface is minimal. The description says what subject matter the reference covers but not how the content is delivered (e.g., whether it is returned whole or in sections, or how large it is), which is the main behavioral unknown.

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 sentences, front-loaded with what the reference contains and closed with the routing instruction. Every clause carries weight: the section list sets expectations and the call-to-use names the alternative 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?

With zero parameters and an output schema provided, the description does not need to explain return values, and it covers purpose and usage adequately. The only mild gap is that it gives no sense of the reference's size or how much of it an agent should read at once, which matters for a document of this breadth.

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?

The tool takes zero parameters, which is the baseline-4 case; there is nothing parameter-wise for the description to explain. The description's listing of reference sections is a content map rather than parameter semantics, but no gap is created.

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 names a specific resource (the full Chosŏn API reference) and enumerates its scope: data formats per module, fit settings, results JSON, simulator/search fields, and errors. That is clearly distinguishable from the action tools in the sibling list, which perform API calls rather than document them.

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?

It gives an explicit trigger ('Read it before call_api') and a second condition ('when a format is unclear'), which routes the agent well against the main sibling it could be confused with. It stops short of stating when-not to bother reading it or how selective to be, so it is not a full when/when-not treatment.

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