Skip to main content
Glama
Sign In

Paypal

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Paypal List Invoices

paypal_list_invoices
Read-onlyIdempotent

List your PayPal invoices. Returns invoice numbers, amounts, statuses, and dates. Use to track billing and outstanding payments.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "_clientId": "your-paypal-client-id",
      "_clientSecret": "your-paypal-client-secret"
    },
    "name": "paypal_list_invoices"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1)
_sandboxNoUse sandbox environment (default: false)
_clientIdYesPayPal app Client ID
page_sizeNoResults per page (default 20, max 100)
_clientSecretYesPayPal app Client Secret

Output Schema

NameRequiredDescriptionDefault
pageNoCurrent page number
itemsNoArray of invoices
total_itemsNoTotal number of invoices
total_pagesNoTotal number of pages

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "description": "List of PayPal invoices",
+  "properties": {
+    "items": {
+      "description": "Array of invoices",
+      "items": {
+        "properties": {
+          "amount": {
+            "properties": {
+              "currency_code": {
+                "description": "Currency code",
+                "type": "string"
+              },
+              "value": {
+                "description": "Total invoice amount",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "create_time": {
+            "description": "Creation timestamp",
+            "type": "string"
+          },
+          "due_date": {
+            "description": "Due date in ISO 8601 format",
+            "type": "string"
+          },
+          "id": {
+            "description": "Invoice ID",
+            "type": "string"
+          },
+          "number": {
+            "description": "Invoice number",
+            "type": "string"
+          },
+          "status": {
+            "description": "Invoice status (e.g., DRAFT, SENT, PAID, CANCELLED)",
+            "type": "string"
+          },
+          "update_time": {
+            "description": "Last update timestamp",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "page": {
+      "description": "Current page number",
+      "type": "number"
+    },
+    "total_items": {
+      "description": "Total number of invoices",
+      "type": "number"
+    },
+    "total_pages": {
+      "description": "Total number of pages",
+      "type": "number"
+    }
+  },
+  "type": "object"
+}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "_clientId": "your-paypal-client-id",
+    "_clientSecret": "your-paypal-client-secret"
+  },
+  {
+    "_clientId": "your-paypal-client-id",
+    "_clientSecret": "your-paypal-client-secret",
+    "page": 2,
+    "page_size": 50
+  }
+]
  3. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, destructiveHint=false, covering the safety profile. The description adds return field context but does not disclose pagination, rate limits, or authentication requirements beyond what the schema provides.

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 concise (three sentences) and front-loaded with the primary action and return data. Every sentence earns its place without redundancy.

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 has 5 parameters and an output schema, the description adequately states what the tool does and returns. However, it omits mention of pagination (page, page_size) and the sandbox parameter, which are present in the schema but could be highlighted for completeness.

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 description does not need to add parameter details. It provides no additional meaning beyond the schema.

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 the verb 'List' and the resource 'your PayPal invoices', and specifies return fields (numbers, amounts, statuses, dates). The sibling tools include paypal_get_invoice for a single invoice, making the purpose distinct and unambiguous.

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?

The description says 'Use to track billing and outstanding payments,' providing a usage context. However, it does not explicitly state when not to use this tool or mention alternatives like paypal_get_invoice for individual invoices.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Paypal toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources