Skip to main content
Glama

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"}), "patent_grant" (new USPTO grants for an applicant), "clinical_trial" (new/updated ClinicalTrials.gov studies), "form_d" (new SEC Form D fundraise notices — params:{state?, industry?, min_amount?, exemption?}, all optional), "news_keyword" (GDELT keyword news alerts, metadata+link only — params:{query, lang?, domains?}), "job_post" (new public job-board postings — params:{ats?, board_token?} or {domain?}, plus optional title_query/location_query), "tool_diff" (re-runs any read-only tool on a schedule and fires on change — params:{tool, args?, fields[], schedule}), "new_entity" (new business registrations from a state business-entity registry — params:{state:"CO", name_query?, entity_type?}). 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). form_d: {state?:"CA", industry?:"Biotechnology", min_amount?:500000, exemption?:"06B"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:"\"semiconductor sanctions\"", lang?:"eng", domains?:["reuters.com"]} (query required). job_post: EITHER {ats:"greenhouse", board_token:"acme"} (exact board) OR {domain:"acme.com"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:"form5500", args?:{...}, fields:["headcount"], schedule:"daily"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule "hourly" needs the paid tier. new_entity: {state:"CO", name_query?:"dental", entity_type?:"limited liability"} — state is required and must be one of FL, NY, CO, OR, CT, TX, PA. Unknown keys in form_d/news_keyword/job_post/tool_diff/new_entity params are rejected at subscribe time.
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.

  1. 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.\"}. clinical_trial: {sponsor?:\"Pfizer\", condition?:\"lung cancer\", phase?:\"PHASE3\"} (sponsor or condition required)."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). form_d: {state?:\"CA\", industry?:\"Biotechnology\", min_amount?:500000, exemption?:\"06B\"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:\"\\\"semiconductor sanctions\\\"\", lang?:\"eng\", domains?:[\"reuters.com\"]} (query required). job_post: EITHER {ats:\"greenhouse\", board_token:\"acme\"} (exact board) OR {domain:\"acme.com\"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:\"form5500\", args?:{...}, fields:[\"headcount\"], schedule:\"daily\"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule \"hourly\" needs the paid tier. new_entity: {state:\"CO\", name_query?:\"dental\", entity_type?:\"limited liability\"} — state is required and must be one of FL, NY, CO, OR, CT, TX, PA. Unknown keys in form_d/news_keyword/job_post/tool_diff/new_entity params are rejected at subscribe time."
    • changedInput schema / properties / type / enum
      Previous value: -[
      -  "sec_8k",
      -  "polymarket_edge",
      -  "fred_series",
      -  "patent_grant",
      -  "clinical_trial"
      -]New value: +[
      +  "sec_8k",
      +  "polymarket_edge",
      +  "fred_series",
      +  "patent_grant",
      +  "clinical_trial",
      +  "form_d",
      +  "news_keyword",
      +  "job_post",
      +  "tool_diff",
      +  "new_entity"
      +]
  2. 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"
      +}
  3. 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"
      +]
  4. 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"
      +]
  5. 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. Future: sms, webhook."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). Capped at 10 SMS/day per subscription."
    • addedInput schema / properties / delivery / properties / sms
      Added value: +{
      +  "description": "E.164 phone number, e.g. \"+15551234567\". Must match the account's verified phone.",
      +  "type": "string"
      +}
  6. 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. Future: sms, webhook.",
      +  "properties": {
      +    "email": {
      +      "description": "Email address to deliver alerts to. Validated against a standard pattern.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  7. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnlyHint=false, idempotentHint=true, openWorldHint=true) by disclosing auth requirements, the always-on feed that must be pulled externally, SMS verification needs and a 10/day cap, and webhook signing behavior. It also surfaces the one-time return of the subscription id, valuable context for a mutation tool.

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-loads purpose, return value, and prerequisites before the type catalog. The block is long, but given ten distinct subscription types the enumeration earns its space; it remains one dense paragraph that could be broken up for readability.

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 no output schema, the description carries the return burden and does so ('Returns the new subscription id', webhook_secret returned once). For a nested-object, ten-type mutation tool, it covers types, params, delivery channels, and constraints thoroughly enough to call correctly.

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 already 100%, so the baseline would be 3, but the description adds genuine meaning by translating enum values into intent (e.g. items:["5.02"] = officer change, params:{topic:"fed"}) and spelling out type-specific filters. It slightly exceeds the schema's own guidance rather than merely restating it.

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 and resource ('Create a proactive monitoring subscription to a live-data event stream') and names the outcome ('Returns the new subscription id'). It is readily distinguishable from siblings like list_subscriptions, unsubscribe, and recent_alerts, which are read/cancel/poll operations rather than subscription creation.

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?

Gives clear prerequisites ('Requires a Pipeworx OAuth account (anonymous + BYO cannot persist subscriptions)') and routes the agent to a sibling for pulling the feed ('pull via recent_alerts'). It does not explicitly state when NOT to use this tool versus polling, but the context is strong and actionable.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.