Skip to main content
Glama

Giphy

by io.github.pipeworx-io
OverviewAdmin

Subscribe to Alerts

subscribe
Idempotent

Create a proactive monitoring subscription to a live-data event stream. Returns the new subscription id. Requires a Pipeworx OAuth account (anonymous + BYO cannot persist subscriptions). Supported types: "sec_8k" (8-K filings matching ticker + item codes — e.g. items:["5.02"] = officer change), "polymarket_edge" (Polymarket↔Kalshi cross-venue mispricings — params:{topic:"fed"}), "fred_series" (new FRED observations — params:{series_id:"UNRATE"}). Delivery channels: feed (always on — pull via recent_alerts or GET registry.pipeworx.io/alerts.json), and optionally email (set delivery:{email:"you@x.com"}) or sms (delivery:{sms:"+15551234567"} — phone must be verified at /account first; 10/day cap).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeYesSubscription type.
paramsYesType-specific filter. sec_8k: {ticker:"AAPL", items?:["5.02","1.01"]}. polymarket_edge: {topic:"fed", min_spread_bps?:500}. fred_series: {series_id:"UNRATE"}. patent_grant: {applicant:"Apple Inc."}. clinical_trial: {sponsor?:"Pfizer", condition?:"lung cancer", phase?:"PHASE3"} (sponsor or condition required).
deliveryNoOptional delivery channels in addition to the always-on persistent feed. {email:"you@x.com"} sends a templated alert per fired event. {sms:"+15551234567"} sends an SMS per event — must match the verified phone on the caller's account (verify at https://pipeworx.io/account first; 10/day cap). {webhook:"https://..."} POSTs each event JSON to your endpoint, HMAC-signed — the response includes delivery.webhook_secret (whsec_…) ONCE; verify X-Pipeworx-Signature = sha256 HMAC of "<X-Pipeworx-Timestamp>.<raw body>". Auto-disabled after 10 consecutive failing runs.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed2 schema fields changed
    • changedInput schema / properties / delivery / description
      Previous value: -"Optional delivery channels in addition to the always-on persistent feed. {email:\"you@x.com\"} sends a templated alert per fired event. {sms:\"+15551234567\"} sends an SMS per event — must match the verified phone on the caller's account (verify at https://pipeworx.io/account first). Capped at 10 SMS/day per subscription."New value: +"Optional delivery channels in addition to the always-on persistent feed. {email:\"you@x.com\"} sends a templated alert per fired event. {sms:\"+15551234567\"} sends an SMS per event — must match the verified phone on the caller's account (verify at https://pipeworx.io/account first; 10/day cap). {webhook:\"https://...\"} POSTs each event JSON to your endpoint, HMAC-signed — the response includes delivery.webhook_secret (whsec_…) ONCE; verify X-Pipeworx-Signature = sha256 HMAC of \"<X-Pipeworx-Timestamp>.<raw body>\". Auto-disabled after 10 consecutive failing runs."
    • addedInput schema / properties / delivery / properties / webhook
      Added value: +{
+  "description": "HTTPS URL to POST fired events to. https only; localhost/private hosts rejected. Signing secret returned once at subscribe time.",
+  "type": "string"
+}
  2. Changed2 schema fields changed
    • changedInput schema / properties / params / description
      Previous value: -"Type-specific filter. sec_8k: {ticker:\"AAPL\", items?:[\"5.02\",\"1.01\"]}. polymarket_edge: {topic:\"fed\", min_spread_bps?:500}. fred_series: {series_id:\"UNRATE\"}. patent_grant: {applicant:\"Apple Inc.\"} (use exact corporate form — match is approximate so wrong suffix returns the whole pool; payload flags the case)."New value: +"Type-specific filter. sec_8k: {ticker:\"AAPL\", items?:[\"5.02\",\"1.01\"]}. polymarket_edge: {topic:\"fed\", min_spread_bps?:500}. fred_series: {series_id:\"UNRATE\"}. patent_grant: {applicant:\"Apple Inc.\"}. clinical_trial: {sponsor?:\"Pfizer\", condition?:\"lung cancer\", phase?:\"PHASE3\"} (sponsor or condition required)."
    • changedInput schema / properties / type / enum
      Previous value: -[
-  "sec_8k",
-  "polymarket_edge",
-  "fred_series",
-  "patent_grant"
-]New value: +[
+  "sec_8k",
+  "polymarket_edge",
+  "fred_series",
+  "patent_grant",
+  "clinical_trial"
+]
  3. Changed3 schema fields changed
    • changedInput schema / properties / params / description
      Previous value: -"Type-specific filter. For sec_8k: {ticker:\"AAPL\", items?:[\"5.02\",\"1.01\"]}. items defaults to all if omitted."New value: +"Type-specific filter. sec_8k: {ticker:\"AAPL\", items?:[\"5.02\",\"1.01\"]}. polymarket_edge: {topic:\"fed\", min_spread_bps?:500}. fred_series: {series_id:\"UNRATE\"}. patent_grant: {applicant:\"Apple Inc.\"} (use exact corporate form — match is approximate so wrong suffix returns the whole pool; payload flags the case)."
    • changedInput schema / properties / type / description
      Previous value: -"Subscription type. v1: \"sec_8k\"."New value: +"Subscription type."
    • changedInput schema / properties / type / enum
      Previous value: -[
-  "sec_8k"
-]New value: +[
+  "sec_8k",
+  "polymarket_edge",
+  "fred_series",
+  "patent_grant"
+]
  4. Changed1 schema field changed
    • addedInput schema / properties / delivery
      Added value: +{
+  "description": "Optional delivery channels in addition to the always-on persistent feed. {email:\"you@x.com\"} sends a templated alert per fired event. {sms:\"+15551234567\"} sends an SMS per event — must match the verified phone on the caller's account (verify at https://pipeworx.io/account first). Capped at 10 SMS/day per subscription.",
+  "properties": {
+    "email": {
+      "description": "Email address to deliver alerts to. Validated against a standard pattern.",
+      "type": "string"
+    },
+    "sms": {
+      "description": "E.164 phone number, e.g. \"+15551234567\". Must match the account's verified phone.",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  5. Added

TDQS

A4.3/5.0
Behavior4/5

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

Beyond annotations (readOnly=false, idempotent=true), the description discloses account requirements, persistence limitations, feed delivery behavior, and SMS verification/caps. It also mentions the return of the subscription id. However, it omits webhook delivery entirely (including the one-time signing secret and auto-disable behavior), though the schema covers that. Since annotations are present and the description adds meaningful behavioral context, a 4 is appropriate 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.

Conciseness4/5

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

The description is a single dense paragraph, but it is front-loaded with the primary purpose and then systematically covers requirements, types, and delivery channels. Every sentence carries useful information; no filler or redundancy. It could be improved with bullet points for the type examples, but the current structure is acceptable for the information density. A 4 reflects efficient, purposeful writing.

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

Completeness4/5

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

For a tool with three parameters, nested objects, and five enum types, the description covers most critical aspects: account requirements, return value, type examples, and delivery options. It omits webhook from the description text and does not provide examples for patent_grant and clinical_trial, but the schema's rich descriptions compensate for these gaps. Overall, the description is sufficiently complete for effective tool selection and invocation, though not exhaustive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description goes beyond by providing concrete examples for three of five types (sec_8k with item codes, polymarket_edge with topic, fred_series with series_id) and explaining delivery channel semantics (email/sms JSON formatting). It does not cover patent_grant or clinical_trial in the description, but the schema already documents those. The added examples and delivery details justify one point above baseline.

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 opens with 'Create a proactive monitoring subscription to a live-data event stream' — a specific verb+resource combination that clearly distinguishes it from sibling tools like list_subscriptions, unsubscribe, and recent_alerts. It also states the return value (new subscription id) and enumerates supported subscription types, leaving no ambiguity about the tool's core function.

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?

The description provides substantial usage context: requires a Pipeworx OAuth account (anonymous + BYO cannot persist), explains the always-on feed with retrieval methods, and details optional delivery channels with prerequisites (verified phone, 10/day SMS cap). It does not explicitly name alternatives or when-not-to-use cases, but the context and sibling names make the appropriate use clear. A 4 is warranted for strong contextual guidance without explicit exclusions.

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

All Giphy toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources