Skip to main content
Glama
PaddleHQ

Paddle MCP Server

Official
by PaddleHQ

get_address

Read-only

Retrieve a customer's address from Paddle Billing using customer ID and address ID to access shipping or billing information.

Instructions

This tool will retrieve an address for a customer from Paddle using its ID and related customer ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
customerIdYesPaddle ID of the customer.
addressIdYesPaddle ID of the address.

Implementation Reference

  • The handler function that implements the core logic of the 'get_address' tool by calling paddle.addresses.get(customerId, addressId) to retrieve the address.
    export const getAddress = async (paddle: Paddle, params: z.infer<typeof Parameters.getAddressParameters>) => {
      try {
        const { customerId, addressId } = params;
        const address = await paddle.addresses.get(customerId, addressId);
        return address;
      } catch (error) {
        return error;
      }
    };
  • src/tools.ts:300-311 (registration)
    Registers the 'get_address' tool in the MCP tools array, including method name, description, parameters schema reference, and required actions.
    {
      method: "get_address",
      name: "Get an address for a customer",
      description: prompts.getAddressPrompt,
      parameters: params.getAddressParameters,
      actions: {
        addresses: {
          read: true,
          get: true,
        },
      },
    },
  • src/api.ts:35-35 (registration)
    Maps the TOOL_METHODS.GET_ADDRESS constant to the getAddress handler function in the toolMap for execution.
    [TOOL_METHODS.GET_ADDRESS]: funcs.getAddress,
  • Defines the constant TOOL_METHODS.GET_ADDRESS as the string 'get_address' used across the codebase for the tool identifier.
    GET_ADDRESS: "get_address",
Behavior3/5

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

Annotations indicate readOnlyHint=true, which the description aligns with by using 'retrieve' (a read operation). The description adds minimal context about the data source ('Paddle') but does not disclose additional behavioral traits such as error handling, authentication needs, or rate limits. With annotations covering safety, a baseline 3 is appropriate for the slight added value.

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 a single, efficient sentence with no wasted words. It front-loads the core action ('retrieve an address') and includes essential details (source, IDs), making it easy to parse quickly.

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?

Given the tool's low complexity (simple retrieval), 100% schema coverage, and read-only annotation, the description is minimally adequate. However, without an output schema, it lacks details on return values or format, and it misses sibling differentiation, leaving gaps in full contextual understanding.

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%, with clear descriptions for both parameters. The description mentions using 'ID and related customer ID,' which mirrors the schema but adds no extra meaning about parameter relationships or usage. This meets the baseline when schema coverage is high.

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 clearly states the tool's purpose: 'retrieve an address for a customer from Paddle using its ID and related customer ID.' It specifies the verb ('retrieve'), resource ('address'), and data source ('Paddle'), but does not explicitly differentiate it from its sibling 'list_addresses' or other get_* tools, which would require a 5.

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?

The description provides no guidance on when to use this tool versus alternatives like 'list_addresses' or other retrieval tools. It mentions the required IDs but offers no context about prerequisites, error conditions, or typical use cases, leaving the agent without operational direction.

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

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