Skip to main content
Glama

Hud

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

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

The description discloses significant behavioral traits beyond annotations: requires OAuth account, delivery channel specifics (always-on feed, optional email/SMS/webhook with constraints), SMS cap (10/day), webhook auto-disable after 10 failures, one-time secret return. Annotations only indicate mutation and idempotency, so description adds crucial context.

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?

The description is appropriately sized for a complex tool with multiple types and delivery channels. It front-loads the main action and return value, then systematically details type-specific parameters, delivery options, and edge cases. Every sentence adds value without redundancy.

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 complexity (5 subscription types, 3 delivery channels, no output schema), the description is remarkably complete. It covers prerequisites, return value (subscription ID), type-specific params, delivery constraints (SMS cap, webhook secret, auto-disable), and account requirements. No critical gaps remain.

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?

With 100% schema coverage, baseline is 3. The description adds extensive meaning: type-specific examples for each enum value (e.g., sec_8k with ticker and items), detailed delivery options (e.g., webhook HMAC signing, SMS verification requirement), and constraints (SMS cap, webhook auto-disable). This far exceeds the schema's minimal descriptions.

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 tool creates a proactive monitoring subscription to a live-data event stream and returns the new subscription ID. It distinguishes from sibling tools like list_subscriptions and unsubscribe by focusing on creation and proactive monitoring.

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 clear context on when to use the tool (to create a subscription) and prerequisites (requires Pipeworx OAuth account; anonymous/BYO cannot persist). It does not explicitly list when not to use alternatives, but the context is sufficiently clear.

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

All Hud 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.9/5.0
Disambiguation4/5

Most tools have distinct purposes, but several query tools (ask_pipeworx, ask_pipeworx_grounded, deep_research, entity_profile, compare_entities, validate_claim) overlap in functionality, which could confuse an agent. The Polymarket and HUD subgroups are well-separated.

Naming Consistency3/5

Tool names use multiple styles: verb_noun (ask_pipeworx), prefixed groups (hud_*, polymarket_*, pipeworx_*), and standalone verbs (forget, recall). While subgroups are consistent, the overall set lacks a uniform pattern.

Tool Count3/5

With 35 tools, the server offers broad data and analytics capabilities. The count is on the high side but justified by the range of features (HUD, general queries, prediction markets, memory, subscriptions). Some tools are highly specialized.

Completeness4/5

The tool surface covers housing data, multi-source querying, prediction markets, memory, subscriptions, and meta-tools. Minor gaps exist (e.g., deeper user account management), but core workflows are well-supported.

Resources