Skip to main content
Glama

Pypi

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.

TDQS

A4.6/5.0
Behavior5/5

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

The description adds significant behavioral context beyond annotations: it details the need for account verification for SMS, the 10/day cap on SMS, the always-on feed channel, and the webhook auto-disable after 10 failures. These are not present in annotations and provide critical transparency for tool invocation.

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 front-loaded with the main purpose and returns information. Each sentence serves a purpose, covering prerequisites, types, and delivery channels without redundancy. It is concise yet comprehensive.

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?

The description covers most aspects: returns the subscription id, prerequisites, delivery channels, and three main types. However, it does not explicitly mention the other two types (patent_grant, clinical_trial) listed in the schema, which would be needed for full completeness given the tool's complexity and no output schema.

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%, so baseline is 3. The description adds value by providing concrete examples (e.g., sec_8k items, polymarket_edge topic) and clarifying requirements (e.g., phone verification, daily caps) that enrich the bare schema 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 verb 'Create a proactive monitoring subscription' and identifies the resource as a 'live-data event stream'. It distinguishes itself from sibling tools like list_subscriptions and unsubscribe by emphasizing proactive monitoring and alert delivery.

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 of a Pipeworx OAuth account and that anonymous/BYO users cannot persist subscriptions. It also provides type-specific parameters and delivery options, implying when to use each subscription type. However, it does not explicitly exclude use cases or compare directly to alternatives.

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

All Pypi 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

A4.1/5.0
Disambiguation4/5

Most tools have clearly distinct purposes, but some overlap exists among the polymarket tools (e.g., bet_research, polymarket_arbitrage, polymarket_edges) and the ask_pipeworx variants. The detailed descriptions help distinguish them, but an agent might still misselect in those groups.

Naming Consistency4/5

Tool names follow a mostly consistent verb_noun pattern in snake_case. Minor deviations exist, such as 'remember' vs 'recall' and the mixed use of verbs and nouns (e.g., 'ask_pipeworx' vs 'polymarket_arbitrage'), but overall the pattern is predictable.

Tool Count3/5

With 35 tools, the server is on the heavy side. While each tool serves a specific purpose, the sheer number may be overwhelming, and some subsets (like the 7 polymarket tools) could potentially be consolidated. Still, the scope justifies many of them.

Completeness4/5

The server covers a wide range of functionalities: Python package management, company research, prediction markets, monitoring, memory, and data queries. Minor gaps exist (e.g., no direct tool for editing subscriptions), but the surface is generally comprehensive and well-rounded.

Resources