Skip to main content
Glama
Sign In

Workspace369

by com.workspace369
OverviewDiscussionsAdmin

Get a recurring invoice

recurring_plans_get
Read-onlyIdempotent

Fetch one recurring invoice plan by id (from recurring_plans_search): everything a search row has, plus sending (auto or review), payment terms, how it ends, any pause or upcoming amount change, pending one-off lines, and its last few autopay charge attempts (status, decline code, next retry). Returns { plan: null } if the id does not exist or is outside a scoped member's clients. Amounts are null without invoices.view_prices.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "recurring_plans_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesPlan id (recurring_plans_search).

Output Schema

NameRequiredDescriptionDefault
planYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "plan": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "amount": {
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "amount_change": {
+              "anyOf": [
+                {
+                  "additionalProperties": false,
+                  "properties": {
+                    "amount": {
+                      "type": [
+                        "number",
+                        "null"
+                      ]
+                    },
+                    "effective_date": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "effective_date",
+                    "amount"
+                  ],
+                  "type": "object"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "attention": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "autopay_state": {
+              "type": "string"
+            },
+            "cadence": {
+              "type": "string"
+            },
+            "card": {
+              "anyOf": [
+                {
+                  "additionalProperties": false,
+                  "properties": {
+                    "brand": {
+                      "type": "string"
+                    },
+                    "last4": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "brand",
+                    "last4"
+                  ],
+                  "type": "object"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "client_id": {
+              "type": "string"
+            },
+            "client_name": {
+              "type": "string"
+            },
+            "collection": {
+              "type": "string"
+            },
+            "currency": {
+              "type": "string"
+            },
+            "cycles_sent": {
+              "type": "number"
+            },
+            "due_in_days": {
+              "type": "number"
+            },
+            "end_after_date": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "ends": {
+              "type": "string"
+            },
+            "heads_up_always": {
+              "type": "boolean"
+            },
+            "id": {
+              "type": "string"
+            },
+            "last_invoice_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "monthly_amount": {
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "name": {
+              "type": "string"
+            },
+            "next_invoice_date": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "pause": {
+              "anyOf": [
+                {
+                  "additionalProperties": false,
+                  "properties": {
+                    "from": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    },
+                    "until": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "from",
+                    "until"
+                  ],
+                  "type": "object"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "pending_one_off_lines": {
+              "type": "number"
+            },
+            "recent_attempts": {
+              "items": {
+                "additionalProperties": false,
+                "properties": {
+                  "at": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "attempt": {
+                    "type": "number"
+                  },
+                  "decline_code": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "hard_decline": {
+                    "type": "boolean"
+                  },
+                  "invoice_id": {
+                    "type": "string"
+                  },
+                  "next_retry_on": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "reason": {
+                    "type": "string"
+                  },
+                  "status": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "invoice_id",
+                  "attempt",
+                  "reason",
+                  "status",
+                  "decline_code",
+                  "hard_decline",
+                  "next_retry_on",
+                  "at"
+                ],
+                "type": "object"
+              },
+              "type": "array"
+            },
+            "retry": {
+              "anyOf": [
+                {
+                  "additionalProperties": false,
+                  "properties": {
+                    "attempt": {
+                      "type": "number"
+                    },
+                    "invoice_id": {
+                      "type": "string"
+                    },
+                    "last_code": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    },
+                    "next_on": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "invoice_id",
+                    "attempt",
+                    "next_on",
+                    "last_code"
+                  ],
+                  "type": "object"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "sending": {
+              "type": "string"
+            },
+            "status": {
+              "type": "string"
+            },
+            "waiting_on_client_invoice_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "status",
+            "attention",
+            "client_id",
+            "client_name",
+            "cadence",
+            "amount",
+            "monthly_amount",
+            "currency",
+            "next_invoice_date",
+            "collection",
+            "autopay_state",
+            "card",
+            "retry",
+            "waiting_on_client_invoice_id",
+            "cycles_sent",
+            "last_invoice_id",
+            "sending",
+            "due_in_days",
+            "heads_up_always",
+            "ends",
+            "end_after_date",
+            "pause",
+            "amount_change",
+            "pending_one_off_lines",
+            "recent_attempts"
+          ],
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "plan"
+  ],
+  "type": "object"
+}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds genuinely useful behavior: a `{ plan: null }` result for missing or out-of-scope ids, and permission-gated null amounts. These are non-obvious traits beyond the structured fields.

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

Conciseness4/5

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

Front-loaded with the core action and id source, then a compact enumeration of returned fields. Dense but each clause carries information; slightly list-heavy given an output schema exists.

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

Completeness5/5

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

Covers the id source, the null-return edge cases, and permission-gated amounts. With an output schema also present, an agent has everything needed to call and interpret this tool correctly.

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?

With 100% schema coverage on the single `id` parameter, the schema already documents it. The description restates the same id-source hint the schema gives, adding no new syntax or format detail, so baseline 3 applies.

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?

States a specific verb (fetch) and resource (one recurring invoice plan) scoped by id, and explicitly names recurring_plans_search as the source of that id. This clearly distinguishes it from the sibling search tool.

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

Usage Guidelines4/5

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

It signals the workflow context by noting the id comes 'from recurring_plans_search', implying this is the detail-fetch that follows a search. It does not state explicit when-not conditions, so it falls short of a 5.

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

All Workspace369 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