Skip to main content
Glama

cancelOrder

Cancel an existing cryptocurrency trading order on supported exchanges using account credentials, order ID, and trading symbol.

Instructions

Cancel an existing order using a configured account

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNameYesAccount name defined in the configuration file (e.g., 'bybit_main')
idYesOrder ID to cancel
symbolYesTrading symbol (e.g., 'BTC/USDT')
paramsNoAdditional exchange-specific parameters

Implementation Reference

  • The core handler function that executes the cancelOrder tool. Retrieves the CCXT exchange instance for the given accountName and invokes exchange.cancelOrder(id, symbol, params). Handles errors and returns formatted content.
    async ({ accountName, id, symbol, params }) => {
      try {
        const exchange = ccxtServer.getExchangeInstance(accountName);
    
        // getExchangeInstance가 성공하면 인증은 보장됨
    
        const result = await exchange.cancelOrder(id, symbol, params);
    
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify(result, null, 2),
            },
          ],
        };
      } catch (error) {
        return {
          content: [
            {
              type: "text",
              text: `Error canceling order for account '${accountName}': ${
                (error as Error).message
              }`,
            },
          ],
          isError: true,
        };
      }
    },
  • Zod input schema defining parameters for the cancelOrder tool: accountName (string), id (string), symbol (string), optional params (record).
    {
      accountName: z
        .string()
        .describe(
          "Account name defined in the configuration file (e.g., 'bybit_main')"
        ),
      id: z.string().describe("Order ID to cancel"),
      symbol: z.string().describe("Trading symbol (e.g., 'BTC/USDT')"),
      params: z
        .record(z.any())
        .optional()
        .describe("Additional exchange-specific parameters"),
    },
  • Direct registration of the 'cancelOrder' tool on the MCP server via server.tool(), including name, description, input schema, and handler function.
    server.tool(
      "cancelOrder",
      "Cancel an existing order using a configured account",
      {
        accountName: z
          .string()
          .describe(
            "Account name defined in the configuration file (e.g., 'bybit_main')"
          ),
        id: z.string().describe("Order ID to cancel"),
        symbol: z.string().describe("Trading symbol (e.g., 'BTC/USDT')"),
        params: z
          .record(z.any())
          .optional()
          .describe("Additional exchange-specific parameters"),
      },
      async ({ accountName, id, symbol, params }) => {
        try {
          const exchange = ccxtServer.getExchangeInstance(accountName);
    
          // getExchangeInstance가 성공하면 인증은 보장됨
    
          const result = await exchange.cancelOrder(id, symbol, params);
    
          return {
            content: [
              {
                type: "text",
                text: JSON.stringify(result, null, 2),
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `Error canceling order for account '${accountName}': ${
                  (error as Error).message
                }`,
              },
            ],
            isError: true,
          };
        }
      },
    );
  • src/server.ts:373-373 (registration)
    Invocation of registerOrderTools(server, ccxtServer) in CcxtMcpServer.registerTools(), which registers the cancelOrder tool among other order tools.
    registerOrderTools(this.server, this);
  • Helper method used by the cancelOrder handler to retrieve the pre-authenticated CCXT Exchange instance for the specified accountName from loaded configuration.
    getExchangeInstance(accountName: string): Exchange {
      const instance = this.exchangeInstances[accountName];
      if (!instance) {
        console.error(
          `No pre-loaded exchange instance found for account name: ${accountName}`,
        );
        // Consider listing available account names: Object.keys(this.exchangeInstances).join(', ')
        throw new Error(
          `Account configuration not found or failed to load for: ${accountName}`,
        );
      }
      return instance;
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the action ('cancel') but doesn't describe what happens after cancellation (e.g., order status changes, potential fees, confirmation requirements), whether it's reversible, or any rate limits. The mention of 'configured account' suggests authentication but lacks specifics about permissions needed.

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 a single, efficient sentence that communicates the core purpose without unnecessary words. It's appropriately sized for a tool with clear parameters documented elsewhere. Every word earns its place, and the structure is straightforward.

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

Completeness2/5

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

For a mutation tool (canceling orders) with no annotations and no output schema, the description is insufficient. It doesn't explain what happens after cancellation, potential side effects, error conditions, or return values. The context signals show 4 parameters with 100% schema coverage, but the behavioral aspects are largely undocumented.

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%, so all parameters are documented in the schema. The description adds no additional parameter information beyond what's already in the schema descriptions. It mentions 'configured account' which relates to 'accountName' parameter but doesn't provide new semantic details. Baseline 3 is appropriate when schema does the heavy lifting.

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?

The description clearly states the verb ('cancel') and resource ('an existing order'), making the purpose immediately understandable. It also mentions 'using a configured account' which adds context about authentication. However, it doesn't explicitly differentiate from sibling tools like 'createOrder' beyond the obvious action difference.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing an existing order), when not to use it, or how it relates to sibling tools like 'fetchOpenOrders' or 'fetchOrder'. The phrase 'using a configured account' hints at authentication but doesn't provide clear usage context.

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/lazy-dinosaur/ccxt-mcp'

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