Skip to main content
Glama
Gainium

Gainium

Official

get_deal

Read-only

Retrieve a single deal by MongoDB ObjectId or UUID, with field presets from minimal to full.

Instructions

Get a single deal by its MongoDB ObjectId. Supports the same field selection presets as list_deals.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dealTypeYesDeal type
dealIdYesDeal identifier. Accepts EITHER the deal's 24-character hex MongoDB ObjectId (e.g. "65f000000000000000000001") OR the deal's UUID. Either form resolves to the same deal — use whichever the deal record exposes. Get both from list_deals (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 deal 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 provide readOnlyHint=true and destructiveHint=false. The description adds the behavioral detail of supporting field selection presets, which is not evident from annotations alone. No contradiction.

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?

The description is extremely concise—two sentences that convey the core purpose and a key distinguishing feature. Every sentence is necessary and no extraneous information.

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 single-deal retrieval tool with an output schema and complete parameter documentation, the description is adequate. It could optionally mention the response format or error cases, but the existing information is sufficient for an AI agent to use the tool correctly.

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 input schema covers 100% of parameters with detailed descriptions. The description adds contextual value by linking the fields parameter to list_deals presets, which reduces ambiguity about what values are accepted beyond the enum.

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 action ('Get a single deal'), the identifier type ('by its MongoDB ObjectId'), and a key feature ('Supports the same field selection presets as list_deals'). It is specific and distinguishes this tool from siblings like list_deals and update_deal.

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 implicitly indicates when to use this tool (when you have a specific deal ID) by contrasting with list_deals. However, it does not explicitly state when not to use it or provide alternative tool names for different use cases.

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