Skip to main content
Glama
iaptic

Iaptic MCP Server

Official
by iaptic

customer_list

List customers with purchase and subscription status. Paginate results by specifying limit and offset to control data volume.

Instructions

List customers from your Iaptic account.

  • Returns a paginated list of customers with their purchase status

  • Each customer includes:

    • Application username

    • Last purchase information

    • Subscription status (active/lapsed)

    • Renewal intent

    • Trial/introductory period status

  • Use limit and offset for pagination (default: 100 customers per page)

  • Results are ordered by creation date (newest first)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of customers to return (default: 100)
offsetNoNumber of customers to skip for pagination

Implementation Reference

  • The _handleTool method processes 'customer_list' by calling this.api.getCustomers(args) and returning the result as JSON content.
    private async _handleTool(name: string, args: any) {
      switch (name) {
        case 'customer_list':
          const customers = await this.api.getCustomers(args);
          return {
            content: [{
              type: "text",
              text: JSON.stringify(customers, null, 2)
            }]
          };
  • Schema definition for 'customer_list' tool: defines input parameters (limit, offset, and optionally appName) and provides the description.
        return [
          {
            name: "customer_list",
            description: `List customers from your Iaptic account.
    - Returns a paginated list of customers with their purchase status
    - Each customer includes:
      - Application username
      - Last purchase information
      - Subscription status (active/lapsed)
      - Renewal intent
      - Trial/introductory period status
    - Use limit and offset for pagination (default: 100 customers per page)
    - Results are ordered by creation date (newest first)${appNameRequired ? '\n- Requires appName parameter when using master key' : ''}`,
            inputSchema: baseSchema
  • src/server.ts:85-91 (registration)
    Tool call routing: The server routes tool calls with name starting with 'customer_' to CustomerTools.handleTool(), which dispatches to 'customer_list'.
    this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
      const { name, arguments: args } = request.params;
      
      try {
        // Route tool calls to appropriate handler
        if (name.startsWith('customer_')) {
          return await this.tools.customers.handleTool(name, args);
  • The API helper method getCustomers() called by the handler to fetch customer list from the Iaptic API endpoint /customers.
    async getCustomers(params?: { limit?: number; offset?: number; appName?: string }) {
      const response = await this.client.get('/customers', { params });
      return response.data;
    }
  • src/server.ts:68-82 (registration)
    Tool listing registration: The server's ListToolsRequestSchema handler calls CustomerTools.getTools() which returns 'customer_list' among other tools.
    private setupHandlers() {
      // List available tools
      this.server.setRequestHandler(ListToolsRequestSchema, async () => {
        return {
          tools: [
            ...this.tools.customers.getTools(),
            ...this.tools.purchases.getTools(),
            ...this.tools.transactions.getTools(),
            ...this.tools.statistics.getTools(),
            ...this.tools.stripe.getTools(),
            ...this.tools.events.getTools(),
            ...this.tools.app.getTools()
          ]
        };
      });
Behavior4/5

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

No annotations provided, but description discloses pagination behavior (default 100, ordering newest first) and the response structure (customer fields). This goes beyond the basic action, though it omits authorization or rate limits.

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?

Bulleted list is concise, well-structured, and front-loaded with the core purpose. Every sentence adds value without redundancy.

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

Completeness4/5

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

Description covers the response fields and pagination behavior adequately for a list tool. However, it could mention if any filtering or sorting options beyond defaults exist.

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

Parameters4/5

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

Schema covers 100% of parameters; description adds context by explaining pagination usage and default value, which aids the agent beyond the schema's basic descriptions.

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 'List customers from your Iaptic account' and details the specific fields returned (username, purchase info, subscription status, etc.), distinguishing it from sibling tools like customer_get (single customer) or customer_add_purchase (adds purchase).

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?

Description explains pagination usage with limit and offset but does not explicitly contrast with siblings or state when to prefer this tool over alternatives like customer_get or purchase_list.

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

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