Skip to main content
Glama

Apology

by io.github.pipeworx-io

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.7/5.0
Behavior5/5

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

The description goes well beyond the annotations to disclose key behaviors: the requirement for a Pipeworx OAuth account, the 10/day SMS cap, the auto-disable of webhooks after 10 consecutive failures, and the one-time return of the webhook signing secret. These details are not captured by the annotations (readOnlyHint=false, openWorldHint=true, idempotentHint=true, destructiveHint=false) but are critical for the agent to use the tool correctly.

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 fairly long but well-structured: it starts with the core purpose, then covers requirements, type-specific details, and delivery channels. Each sentence adds value, though a minor redundancy exists in explaining the SMS cap twice (once in description and once in delivery schema). Overall, it is front-loaded with the essential purpose and progressively adds detail.

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?

Given the tool's complexity (3 parameters, nested objects, no output schema), the description covers all essential aspects: purpose, prerequisites, type-specific parameter formats, delivery options with constraints, and behavioral notes (webhook auto-disable, one-time secret). There are no gaps; the agent can fully understand how to invoke the tool and what to expect.

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

Parameters5/5

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

The schema has 100% description coverage, but the description adds significant semantic value by explaining each type's parameters with concrete examples (e.g., items:['5.02'] = officer change for sec_8k, topic:'fed' for polymarket_edge, series_id:'UNRATE' for fred_series). It also details the delivery sub-object's constraints (E.164 phone, HTTPS URL, HMAC signing). This level of detail makes the parameters understandable 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 core action: 'Create a proactive monitoring subscription to a live-data event stream. Returns the new subscription id.' It also distinguishes between subscription types and delivery channels, providing specific examples for each (e.g., sec_8k for SEC filings, polymarket_edge for cross-venue mispricings). This sets it apart from sibling tools like list_subscriptions and unsubscribe.

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 explicitly states the prerequisite: 'Requires a Pipeworx OAuth account (anonymous + BYO cannot persist subscriptions).' It provides detailed guidance on when to use each subscription type (e.g., sec_8k for SEC filings matching ticker+item codes, fred_series for FRED observations) and channels (feed always on, optional email/sms with limits). While it doesn't explicitly say when NOT to use this tool, the context is clear enough given the sibling tools and the examples.

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

All Apology 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.

TDQS

A3.7/5.0
Disambiguation2/5

ask_pipeworx, ask_pipeworx_beta, and ask_pipeworx_grounded are near-duplicates with beta explicitly identical to the stable version, causing potential misselection. ai_visibility_check and scan_competitor_ai_presence overlap heavily, and resolve_entity/discover_tools/ask_pipeworx all serve lookup purposes. Many tools are distinct, but the boundaries around the core query tools are blurry.

Naming Consistency2/5

Naming is inconsistent: mostly snake_case but mixed verb styles (ask_pipeworx vs pipeworx_feedback vs resolve_entity), brand prefixes applied irregularly, and no uniform convention (e.g., subscribe/unsubscribe/list_subscriptions vs forget/remember/recall vs polymarket_arbitrage/edges/edge_tracker). Some names are descriptive, but the set lacks a predictable pattern.

Tool Count2/5

32 tools is above the 25 threshold for a heavy surface, and the server mixes unrelated domains (data lookup, prediction markets, memory, subscriptions, AI visibility, apology generation). While a large data platform could justify many tools, the random inclusions (apology_generate, generate_llms_txt, scan_dependency) suggest a lack of scoping. Several tools could be consolidated without loss.

Completeness4/5

For the dominant data-research/prediction-market domain, coverage is strong: lookup, grounded verification, research, entity resolution, comparison, arbitrage scanning, fill risk, subscriptions, memory, and discovery are all present. Minor gaps exist (no direct account management beyond subscriptions, no tool to modify stored memories), but agents can mostly achieve their goals. The stray non-domain tools do not hurt completeness of the core platform.

Resources