Skip to main content
Glama

Synoptic

by com.synoptic
OverviewDiscussionsAdmin

Read package subscription

get_stream_package_subscription
Read-onlyIdempotent

Read the signed-in user’s paid subscription status for a stream package, including price and scheduled cancellation. Returns null when no subscription is found. Use get_stream_subscription for a direct subscription to one stream. Subscribing, changing or cancelling happens in the Synoptic app.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
streamPackageIdYesPackage ID from list_stream_packages or list_my_stream_packages.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
subscriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / subscription / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "active": {
-        "description": "True while status is active or trialing.",
-        "type": "boolean"
-      },
-      "cancelAt": {
-        "description": "ISO 8601 time the subscription is scheduled to end, or null when no cancellation is scheduled.",
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "currency": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "customTargets": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Number of custom targets the subscription allows, or null when it sets no allowance."
-      },
-      "interval": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "intervalCount": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "price": {
-        "description": "Price in the currency’s smallest unit.",
-        "type": [
-          "number",
-          "null"
-        ]
-      },
-      "signupTrial": {
-        "description": "True for a trial started at Synoptic sign-up.",
-        "type": "boolean"
-      },
-      "status": {
-        "description": "Stripe subscription status, such as active, trialing, past_due or canceled.",
-        "type": "string"
-      }
-    },
-    "required": [
-      "active",
-      "status",
-      "interval",
-      "intervalCount",
-      "price",
-      "currency",
-      "cancelAt",
-      "customTargets",
-      "signupTrial"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "active": {
+        "description": "True while status is active or trialing.",
+        "type": "boolean"
+      },
+      "cancelAt": {
+        "description": "ISO 8601 time the subscription is scheduled to end, or null when no cancellation is scheduled.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "currency": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "customTargets": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Number of custom targets the subscription allows, or null when the subscription records none; set_stream_custom_targets and patch_stream_custom_targets then accept no targets."
+      },
+      "interval": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "intervalCount": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "price": {
+        "description": "Price in the currency’s smallest unit.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "signupTrial": {
+        "description": "True for a trial started at Synoptic sign-up.",
+        "type": "boolean"
+      },
+      "status": {
+        "description": "Stripe subscription status, such as active, trialing, past_due or canceled.",
+        "type": "string"
+      }
+    },
+    "required": [
+      "active",
+      "status",
+      "interval",
+      "intervalCount",
+      "price",
+      "currency",
+      "cancelAt",
+      "customTargets",
+      "signupTrial"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
  2. Changed2 schema fields changed
    • addedInput schema / properties / streamPackageId / description
      Added value: +"Package ID from list_stream_packages or list_my_stream_packages."
    • changedOutput schema / properties / subscription / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "active": {
-        "type": "boolean"
-      },
-      "cancelAt": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "currency": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "customTargets": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "interval": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "intervalCount": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "price": {
-        "description": "Price in the currency’s smallest unit.",
-        "type": [
-          "number",
-          "null"
-        ]
-      },
-      "signupTrial": {
-        "type": "boolean"
-      },
-      "status": {
-        "type": "string"
-      }
-    },
-    "required": [
-      "active",
-      "status",
-      "interval",
-      "intervalCount",
-      "price",
-      "currency",
-      "cancelAt",
-      "customTargets",
-      "signupTrial"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "active": {
+        "description": "True while status is active or trialing.",
+        "type": "boolean"
+      },
+      "cancelAt": {
+        "description": "ISO 8601 time the subscription is scheduled to end, or null when no cancellation is scheduled.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "currency": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "customTargets": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Number of custom targets the subscription allows, or null when it sets no allowance."
+      },
+      "interval": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "intervalCount": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "price": {
+        "description": "Price in the currency’s smallest unit.",
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "signupTrial": {
+        "description": "True for a trial started at Synoptic sign-up.",
+        "type": "boolean"
+      },
+      "status": {
+        "description": "Stripe subscription status, such as active, trialing, past_due or canceled.",
+        "type": "string"
+      }
+    },
+    "required": [
+      "active",
+      "status",
+      "interval",
+      "intervalCount",
+      "price",
+      "currency",
+      "cancelAt",
+      "customTargets",
+      "signupTrial"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuine behavioral context beyond that: the null return when no subscription exists, and the fact that mutation is out of band in the Synoptic app. It stops short of describing pagination or error behavior, so a 4 rather than 5.

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?

Three short sentences, front-loaded with the core purpose, then the null case, then routing guidance. Every sentence carries distinct information with no filler.

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?

With an output schema present the description needn't spell out return fields, yet it still flags the null case. For a single-parameter read tool with full annotation coverage, nothing needed to invoke or route the tool correctly is missing.

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?

There is one parameter and schema description coverage is 100%, with the schema already telling the agent where the package ID comes from (list_stream_packages or list_my_stream_packages). The description adds no format or constraint detail beyond the schema, so the baseline of 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 (read) and resource (signed-in user's paid subscription status for a stream package) and enumerates the payload (price, scheduled cancellation). It explicitly distinguishes itself from the sibling get_stream_subscription by scoping to packages versus a direct stream subscription.

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

Usage Guidelines5/5

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

Names the alternative (get_stream_subscription) and the condition that selects it (a direct subscription to one stream), and further rules out write operations by stating subscribing/changing/cancelling happens in the Synoptic app. Both when-to-use and when-not-to-use are explicit.

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

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