Skip to main content
Glama
Gainium

Gainium

Official

get_bot

Read-only

Retrieve a specific DCA, combo, or grid bot using its MongoDB ObjectId or UUID, with customizable field selection for detailed views.

Instructions

Get a single bot by its MongoDB ObjectId or UUID. Supports the same field selection presets as list_bots.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
botTypeYesBot type
botIdYesBot identifier. Accepts EITHER the bot's 24-character hex MongoDB ObjectId (e.g. "65f000000000000000000001") OR the bot's UUID (e.g. "550e8400-e29b-41d4-a716-446655440000"). Either form resolves to the same bot — use whichever the bot record exposes. Get both from list_bots (the `_id` and `uuid` fields).
fieldsNoField selection: preset ("minimal", "standard", "extended", "full") or comma-separated fields (e.g. "_id,uuid,settings.name,profit.total"). Default: "standard"
paperContextNoPaper trading context (true = paper, false = real). Default: false

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNoOK on success, NOTOK on a handled API error.
reasonNoError reason when status is NOTOK; null otherwise.
dataNoThe bot record; fields present depend on the `fields` preset.
metaNoPagination / result metadata, present on list-style responses.
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description's addition that it gets a bot aligns well. It also adds context about ID formats and field presets, which is useful beyond annotations.

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, no wasted words. First sentence states purpose, second adds context. Very concise.

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?

Given the output schema exists and annotations are provided, the description covers the core functionality. It could mention error cases, but is sufficient for a simple get tool.

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?

Schema coverage is 100%, but the description adds value by explicitly mentioning that botId accepts ObjectId or UUID and referencing list_bots for field presets, which is not in the schema.

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 the tool gets a single bot by its MongoDB ObjectId or UUID, and mentions field selection presets. It is specific and distinguishes from sibling tools like list_bots.

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 description implies usage for retrieving a single bot with field selection, and references list_bots for presets. However, it does not explicitly state when not to use or provide alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Gainium/gainium-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server