Skip to main content
Glama
AbbottDevelopments

Shopmonkey MCP Server

list_users

Retrieve shop users and technicians from Shopmonkey with filtering by location and pagination controls.

Instructions

List shop users and technicians from Shopmonkey.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
locationIdNoFilter by location ID. Defaults to SHOPMONKEY_LOCATION_ID env var if set.
limitNoMaximum number of results to return (default: 25)
pageNoPage number for pagination (default: 1)

Implementation Reference

  • The handler function for the 'list_users' tool. It processes the input arguments, applies the default location, and makes a request to the Shopmonkey API.
    async list_users(args) {
      const params: Record<string, string> = {};
      if (args.locationId !== undefined) params.locationId = String(args.locationId);
      if (args.limit !== undefined) params.limit = String(args.limit);
      if (args.page !== undefined) params.page = String(args.page);
      applyDefaultLocation(params);
    
      const data = await shopmonkeyRequest<User[]>('GET', '/user', undefined, params);
      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
    },
  • The schema definition for the 'list_users' tool, describing its name, description, and expected input parameters.
      name: 'list_users',
      description: 'List shop users and technicians from Shopmonkey.',
      inputSchema: {
        type: 'object' as const,
        properties: {
          locationId: { type: 'string', description: 'Filter by location ID. Defaults to SHOPMONKEY_LOCATION_ID env var if set.' },
          limit: { type: 'number', description: 'Maximum number of results to return (default: 25)' },
          page: { type: 'number', description: 'Page number for pagination (default: 1)' },
        },
      },
    },
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'technicians' which clarifies the user type, but fails to disclose pagination behavior, whether deleted/inactive users are included, permission requirements, or what the response structure looks like.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single sentence is front-loaded with the verb, contains no redundancy, and efficiently conveys the resource and source system. However, given the lack of annotations and output schema, the extreme brevity leaves critical gaps.

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?

With zero annotations, no output schema, and three parameters, the description is insufficiently minimal. It should explain the relationship between 'users' and 'technicians', describe expected return values, or clarify pagination behavior. Currently inadequate for proper agent operation without external knowledge.

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 the schema fully documents locationId, limit, and page. The description adds no parameter-specific context, but with complete schema coverage, baseline 3 is appropriate.

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 uses a specific verb (List) and resource (shop users and technicians) from a specific system (Shopmonkey). It distinguishes from siblings like list_customers or list_vehicles by specifying 'users and technicians' as the target resource.

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 the sibling get_user, or when to apply the locationId filter versus querying all locations. No alternatives or prerequisites are mentioned.

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