Skip to main content
Glama
mattcoatsworth

ShipStation API MCP Server

list_products

Retrieve product listings from ShipStation with pagination, filtering by SKU, name, or category, and sorting options to manage inventory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number
pageSizeNoNumber of products per page (max 500)
sortByNoSort products by a specific field
sortDirNoSort direction
skuNoFilter by SKU
nameNoFilter by product name
productCategoryIdNoFilter by product category ID
showInactiveNoInclude inactive products

Implementation Reference

  • The handler function that executes the tool logic: calls shipStationClient.getProducts(params), formats the response as MCP content with JSON stringified products, or returns error.
    handler: async (params) => {
      try {
        const products = await shipStationClient.getProducts(params);
        return {
          content: [{ type: "text", text: JSON.stringify(products, null, 2) }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: error.message }],
          isError: true
        };
      }
    }
  • Input schema validation using Zod for optional pagination, sorting, and filtering parameters.
    schema: {
      page: z.number().optional().describe("Page number"),
      pageSize: z.number().optional().describe("Number of products per page (max 500)"),
      sortBy: z.string().optional().describe("Sort products by a specific field"),
      sortDir: z.enum(["ASC", "DESC"]).optional().describe("Sort direction"),
      sku: z.string().optional().describe("Filter by SKU"),
      name: z.string().optional().describe("Filter by product name"),
      productCategoryId: z.number().optional().describe("Filter by product category ID"),
      showInactive: z.boolean().optional().describe("Include inactive products")
    },
  • src/server.js:184-191 (registration)
    Generic registration loop for all tools. The 'productTools' array (containing 'list_products') is spread into this list at line 179.
    ].forEach(tool => {
      server.tool(
        tool.name,
        tool.schema,
        tool.handler,
        { description: tool.description }
      );
    });
  • Supporting method in ShipStationClient that performs the actual GET /products API call with query parameters.
    async getProducts(params) {
      return this.request('GET', '/products', null, params);
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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/mattcoatsworth/shipstation-mcp-server'

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