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.

TDQS

A4.4/5.0
Behavior4/5

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

Adds substantial behavioral context beyond annotations: explains OAuth requirement, return of subscription ID, delivery channel details, SMS cap, and webhook failure handling. The idempotentHint annotation is not fully addressed (description implies each call creates a new subscription), but overall transparency is strong.

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?

Description is efficiently structured with purpose front-loaded, followed by requirements, types, and delivery details. No redundant sentences, but could be slightly tighter.

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?

Covers all aspects: types, parameters, delivery options, authentication requirements, and limitations. Without an output schema, it adequately describes return value (subscription ID) and behaviors.

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%, and the description enriches parameters with examples for each type's params (e.g., 'sec_8k: {ticker:"AAPL", items?:["5.02"]}'}) and detailed delivery channel semantics beyond the schema's basic 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 'Create a proactive monitoring subscription to a live-data event stream' using a specific verb ('Create') and resource ('subscription'). It distinguishes from sibling tools like 'list_subscriptions' and 'unsubscribe' 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, lists supported types with examples, and details delivery channels with limitations (e.g., SMS 10/day cap, webhook auto-disable). Does not explicitly state when not to use, but overall guidance is clear.

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

A4/5.0
Disambiguation4/5

Most tools target a distinct action or resource, and the long routing descriptions make choices like ask_pipeworx vs ask_pipeworx_grounded vs deep_research clear. The main weak spots are ask_pipeworx_beta being currently identical to ask_pipeworx and the six overlapping Polymarket tools, but each has a discernible workflow.

Naming Consistency3/5

Naming has internally consistent subfamilies such as censtatd_*, ask_pipeworx*, and polymarket_*, but overall it mixes verb-first names (get_table, validate_claim, subscribe), noun-first names (entity_profile, bet_research, pipeworx_feedback), and bare imperatives (remember, forget, recall). The set is readable but does not follow one convention.

Tool Count2/5

35 tools exceeds the 25+ threshold and feels heavy, especially since many tools (generate_llms_txt, scan_dependency, pipeworx_feedback, pipeworx_trending) are unrelated to the HK Census core implied by the server name. The broad Pipeworx scope explains the width, but the surface is still large for an agent to navigate efficiently.

Completeness4/5

For a read-only research/data-access gateway, coverage is strong: generic lookup, grounded verification, deep research, entity profile/compare/change, entity resolution, memory, and subscription lifecycle are all represented. Minor gaps exist, such as no subscription update, no explicit bulk/export path, and fewer HK C&SD convenience wrappers, but agents can work around them.