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"}). 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. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Exceeds annotations by detailing return value ('Returns the new subscription id'), limitations (SMS 10/day cap, webhook auto-disable after 10 failures), and prerequisites (verified phone). No contradictions with annotations.

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?

Lengthy but well-structured and efficient. Front-loaded with core purpose, then requirements, types, and delivery. Every sentence adds value; no redundancy.

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?

Covers prerequisites, types, delivery options, and limitations. No output schema, but return value is mentioned. Could briefly note that subscriptions are persistent and manageable via other tools, but not essential.

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?

Schema coverage is 100%; the description adds substantial meaning to each parameter: explains type-specific filter structures (e.g., sec_8k items codes), delivery channel details (webhook HMAC signing, auto-disable). Highly enriches 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 verb ('Create') and resource ('proactive monitoring subscription to a live-data event stream'). It distinguishes this from sibling tools like list_subscriptions, unsubscribe, and recent_alerts by focusing on 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?

Provides explicit context: requires Pipeworx OAuth account, with clear examples for supported types and delivery channels. No direct when-not-to-use, but the context is sufficient for an agent to decide.

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.

TDQS

A3.9/5.0
Disambiguation3/5

Several tools overlap in purpose: ask_pipeworx, ask_pipeworx_beta, ask_pipeworx_grounded, and deep_research all route to the same underlying catalog, and composite tools like entity_profile, recent_changes, compare_entities, and validate_claim draw on similar company-data sources. However, the descriptions are extremely detailed with explicit usage guidance, so an agent can usually pick correctly despite the overlap.

Naming Consistency4/5

Most tool names follow a verb_noun snake_case pattern (ask_pipeworx, compare_entities, list_subscriptions, validate_claim), and domain prefixes like nola_, pipeworx_, and polymarket_ help group tools. Minor deviations such as entity_profile, recent_changes, and polymarket_edges are still readable and do not undermine the overall pattern.

Tool Count2/5

At 34 tools, the set spans far beyond the 'Data Nola' name: New Orleans open data, general Pipeworx data research, Polymarket arbitrage, npm dependency scanning, AI visibility, memory, and subscriptions. This breadth makes the surface heavy and forces agents to triage a large and heterogeneous toolset.

Completeness4/5

The broader research platform is well covered: question answering, entity resolution, profiles, comparisons, claim validation, subscriptions, memory, and NOLA dataset querying all have solid lifecycle support. Minor gaps exist—no NOLA dataset metadata or write tools, no Polymarket order execution—but these are acceptable for a read-only data server.