list_customers
Retrieve customer records from GoCardless to manage payment accounts and view client information. Use limit parameter to control the number of results returned.
Instructions
List all customers from GoCardless
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of customers to retrieve (default: 50) |
Implementation Reference
- src/gocardless_mcp/server.py:257-277 (handler)Handler for the 'list_customers' tool. Retrieves a list of customers from GoCardless using the client API, limited by optional 'limit' parameter, and returns formatted JSON text content.if name == "list_customers": limit = arguments.get("limit", 50) customers = client.customers.list(params={"limit": limit}) result = [] for customer in customers.records: result.append( { "id": customer.id, "email": customer.email, "given_name": customer.given_name, "family_name": customer.family_name, "company_name": customer.company_name, "created_at": customer.created_at, } ) return [ types.TextContent( type="text", text=f"Found {len(result)} customers:\n{_format_json(result)}", ) ]
- src/gocardless_mcp/server.py:39-51 (registration)Registration of the 'list_customers' tool in the @server.list_tools() handler, including its description and input schema.types.Tool( name="list_customers", description="List all customers from GoCardless", inputSchema={ "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of customers to retrieve (default: 50)", } }, }, ),
- src/gocardless_mcp/server.py:42-50 (schema)Input schema definition for the 'list_customers' tool, defining an optional 'limit' integer parameter.inputSchema={ "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of customers to retrieve (default: 50)", } }, },
- src/gocardless_mcp/server.py:14-21 (helper)Helper function to initialize and return the GoCardless client used in the tool handler.def get_client() -> gocardless_pro.Client: """Initialize and return GoCardless client.""" access_token = os.environ.get("GOCARDLESS_ACCESS_TOKEN") if not access_token: raise ValueError("GOCARDLESS_ACCESS_TOKEN environment variable is required") environment = os.environ.get("GOCARDLESS_ENVIRONMENT", "sandbox") return gocardless_pro.Client(access_token=access_token, environment=environment)
- src/gocardless_mcp/server.py:559-562 (helper)Helper function to format JSON output used in the tool response.def _format_json(data: Any) -> str: """Format data as JSON string.""" import json return json.dumps(data, indent=2)