Skip to main content
Glama

Gogi

by ai.gogi.api
OverviewDiscussions(2)Admin

List Trading Instances

list_instances
Read-onlyIdempotent

List the user's trading instances with id, name, status, is_live, and broker. Call this before start_instance / stop_instance / activate_algo / delete_instance to confirm instance_id (not algo_id). status pending/stopped means not live yet. Stopped/pending still count toward the max-10 limit until delete_instance.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
countNo
errorNo
messageNo
successNo
instancesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedOutput schema / description
      Previous value: -"Structured Gogi result. Error responses include error and message fields."New value: +"Structured result. Error responses include error and message."
    • addedOutput schema / properties
      Added value: +{
+  "count": {
+    "type": "integer"
+  },
+  "error": {
+    "type": "string"
+  },
+  "instances": {
+    "type": "array"
+  },
+  "message": {
+    "type": "string"
+  },
+  "success": {
+    "type": "boolean"
+  }
+}
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "description": "Structured Gogi result. Error responses include error and message fields.",
+  "type": "object"
+}
  3. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already cover readOnly, idempotent, and non-destructive semantics, so the safety profile is free. The description goes further with real operational context: pending/stopped means not live yet, and stopped/pending instances still count toward the max-10 limit until delete_instance — a quota behavior no annotation could convey.

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?

Four short sentences, each carrying a distinct payload: what is returned, when to call it, the id-type trap, and the quota rule. Nothing is filler and the constraining facts are front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, yet the description still supplies the id-disambiguation and max-10 quota rules an agent needs before mutating instances. Combined with the annotation-covered safety profile, nothing material is missing for a zero-argument read 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?

The tool takes zero parameters, so the baseline is 4. The description's enumeration of returned fields is output information rather than parameter meaning, so there is nothing additional for it to convey here.

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?

States a specific verb and resource (list the user's trading instances) and enumerates the returned fields id, name, status, is_live, broker. This cleanly separates it from siblings like list_my_algos, list_brokers, and list_backtest_runs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs the agent to call this before start_instance / stop_instance / activate_algo / delete_instance in order to confirm instance_id (not algo_id). That is a named when-to-use condition plus a named pitfall, which is the strongest form of routing guidance.

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

All Gogi toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources