Skip to main content
Glama

API Guide

get_api_guide
Read-onlyIdempotent

Start here. Returns the candle market-memory guide: what the evidence supports, the chart presets, the recommended call order, how to read bands and track records, and how access works. Free; explains current access for agents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNo'candles' (default): the start-here guide for the listed tools. 'all' adds the legacy full-profile catalog; other topics cover legacy tool familiescandles

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / topic / default
      Previous value: -"all"New value: +"candles"
    • changedInput schema / properties / topic / description
      Previous value: -"Focus area: 'all' for full guide, or a specific topic"New value: +"'candles' (default): the start-here guide for the listed tools. 'all' adds the legacy full-profile catalog; other topics cover legacy tool families"
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "all",
      -  "polymarket",
      -  "analogs",
      -  "backtest",
      -  "patterns",
      -  "selector"
      -]New value: +[
      +  "candles",
      +  "all",
      +  "polymarket",
      +  "analogs",
      +  "backtest",
      +  "patterns",
      +  "selector"
      +]
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly=true, idempotent=true, destructive=false and openWorld=false, so the safety profile is fully covered. The description adds value beyond that by disclosing cost ('Free') and the access-explanation behavior, which an agent would otherwise have to discover empirically.

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?

Front-loads the key directive in two words ('Start here.'), then enumerates contents in a single readable sentence. The list is slightly dense but every item earns its place by telling the agent what the guide contains.

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 zero-required-param orientation tool with no output schema, the description adequately conveys what the agent receives and why to call it first. Minor gaps remain around the non-default topic topics, but nothing essential to invoking it correctly is missing.

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

Parameters3/5

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

Schema description coverage is 100% and the lone 'topic' enum is fully documented in-schema (including the legacy-topic distinction for 'all'). The description adds no parameter-level detail, so the baseline 3 applies since the schema does all the work.

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+resource ('Returns the candle market-memory guide') and inventories its contents (evidence scope, chart presets, call order, band/track reading, access). It reads clearly as the orientation entry point and is implicitly distinct from the data-returning siblings, though it never names an alternative to sharpen the contrast.

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?

The imperative 'Start here' gives clear, actionable context for when to call it, and 'Free; explains current access for agents' signals the cost/access condition. There is no explicit when-not guidance or named alternative, which keeps it short of a 5.

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