Skip to main content
Glama
AbbottDevelopments

Shopmonkey MCP Server

get_order

Retrieve detailed work order information by ID to access customer, vehicle, and service data for shop management operations.

Instructions

Get detailed information about a single work order by its ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe work order ID

Implementation Reference

  • The handler implementation for get_order, which takes an ID and performs a GET request to retrieve order details.
    async get_order(args) {
      if (!args.id) return { content: [{ type: 'text', text: 'Error: id is required' }], isError: true };
      const data = await shopmonkeyRequest<Order>('GET', `/order/${sanitizePathParam(String(args.id))}`);
      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
    },
  • The schema definition for get_order, defining the tool's input parameters and description.
    {
      name: 'get_order',
      description: 'Get detailed information about a single work order by its ID.',
      inputSchema: {
        type: 'object' as const,
        properties: {
          id: { type: 'string', description: 'The work order ID' },
        },
        required: ['id'],
      },
    },
Behavior2/5

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

No annotations provided, so description carries full burden. States 'Get' implying read-only safety, but provides no details on error behavior (e.g., 404 for invalid ID), cache behavior, or what constitutes 'detailed' information beyond the order ID parameter.

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?

Single front-loaded sentence of 10 words with zero redundancy. Every word earns its place: verb, resource scope, and key parameter reference.

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?

Adequate for a single-parameter retrieval tool with complete schema coverage. Acceptable given no output schema exists, though could benefit from noting that the ID must be known (likely from list_orders) and hinting at the data richness expected.

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 has 100% description coverage ('The work order ID'), so baseline is met. Description mentions 'by its ID' but adds no additional semantics regarding ID format, constraints, or lookup requirements beyond the schema definition.

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?

Clear verb 'Get' with specific resource 'work order'. Scope qualifiers 'single' and 'by its ID' effectively distinguish this from sibling list_orders, though 'detailed information' is vague about what data is returned.

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

Usage Guidelines3/5

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

Implicitly signals ID-based lookup via 'by its ID', distinguishing from list/search siblings. However, lacks explicit guidance on when to use list_orders first to find IDs, or error handling if ID is unknown.

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/AbbottDevelopments/shopmonkey-mcp-server'

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