Skip to main content
Glama

approve_order

Idempotent

Approve an order by providing its ID. This updates the order status to approved.

Instructions

Approve an order

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesID of the order

Implementation Reference

  • Registers the 'approve_order' tool on the McpServer. The schema requires an 'id' (positive integer). The handler calls the API endpoint /orders/{id}/approve and logs the response.
    server.registerTool(
      "approve_order",
      {
        description: "Approve an order",
        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true },
        inputSchema: { id: z.number().int().positive().describe("ID of the order") },
      },
      async ({ id }) => {
        try {
          const record = await apiPut<EduframeRecord>(`/orders/${id}/approve`, {});
          void logResponse("approve_order", { id }, record);
          return formatShow(record, "order");
        } catch (error) {
          return formatError(error);
        }
      },
    );
  • Handler function for 'approve_order'. Makes an apiPut call to /orders/{id}/approve, logs the response, and returns a formatted show result.
    async ({ id }) => {
      try {
        const record = await apiPut<EduframeRecord>(`/orders/${id}/approve`, {});
        void logResponse("approve_order", { id }, record);
        return formatShow(record, "order");
      } catch (error) {
        return formatError(error);
      }
    },
  • Input schema for 'approve_order': requires a single 'id' field of type number (positive integer).
    {
      description: "Approve an order",
      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true },
      inputSchema: { id: z.number().int().positive().describe("ID of the order") },
  • Import of registerOrderTools from './orders', which registers the approve_order tool.
    import { registerOrderTools } from "./orders";
  • Shows that the operationId 'approve_order_by_id' is transformed into the tool name 'approve_order' by stripping '_by_id' suffix.
    *   "approve_order_by_id"                      → "approve_order" (action)
Behavior3/5

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

Annotations already indicate idempotentHint=true, so the description adds no extra behavioral context. It does not contradict annotations but also does not elaborate on side effects or safety.

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, using a single sentence with no superfluous words.

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

Completeness3/5

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

For a simple action with one parameter, the description is minimally adequate but lacks details about expected results, error conditions, or order state requirements.

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?

Input schema covers the single parameter ('id') fully, and the description adds no additional meaning beyond what the schema provides.

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 ('Approve') and the resource ('an order'), distinguishing it from siblings like 'cancel_order' and 'deny_order'.

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?

No guidance is provided on when to use this tool versus alternatives such as 'deny_order' or 'cancel_order', nor does it mention prerequisites like order state.

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/martijnpieters/eduframe-mcp'

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