Glossary
Definitions of MCP protocol terms and Pipeworx-specific concepts as used across the
gateway, docs, and tool catalog. Skim or search; every term is anchor-linkable
(/glossary#tool) for stable citation.
Protocol
Core MCP concepts and the three primitives the protocol defines.
- Model Context Protocol (MCP)
-
An open protocol for connecting AI agents to external tools and data. MCP standardizes how an agent discovers, calls, and cites data sources over JSON-RPC. The spec defines three primitives — Tools, Resources, and Prompts — that any MCP-compatible client (Claude Desktop, Claude Code, Cursor, VS Code, ChatGPT, etc.) can consume.
- Tool
-
An MCP primitive representing a callable function the agent can invoke — for example, fred_get_series or edgar_company_filings. Each tool has an inputSchema (often with examples), an outputSchema, and a description. Pipeworx exposes 1,409 tools across 389 packs.
- Resource
-
An MCP primitive for citable URIs that point to specific entities — e.g. pipeworx://edgar/company/0000320193/filings or pipeworx://clinicaltrials/study/NCT04568358. Resources let an agent embed durable references in its output instead of pasting raw data, and resources/read fetches current content for any URI.
- Prompt
-
An MCP primitive representing a pre-built workflow the agent can invoke by name — e.g. research_public_company(company) or drug_safety_profile(drug_name). Prompts encode optimal multi-step plans for common tasks so the agent does not have to rediscover the chain on every session.
Pipeworx-specific
Concepts and naming conventions specific to the Pipeworx gateway.
- Gateway
-
The single MCP server at https://gateway.pipeworx.io/mcp that fronts every pack. Agents connect to the gateway once and access the full catalog — no per-pack configuration. The gateway handles auth, rate limiting, routing, caching, telemetry, and meta-tools.
- Pack
-
A bundle of tools for a single data source — for example, the edgar pack exposes SEC EDGAR filings, and the fred pack exposes FRED economic series. Packs are stateless and live in mcps/{slug}/src/index.ts in the repo. Pipeworx ships 389 packs.
- Vertical
-
A curated bundle of packs optimized for a domain — Housing Intel, FinTech, PharmaPulse, GovCon Radar, AgriPulse, TradeGuard, and GreenLens. Connect to a vertical with ?vertical={slug} on the gateway URL to load only the relevant subset of tools rather than the full catalog.
- Compound tool
-
A pack-level tool that chains multiple underlying API calls into one response — for example, housing_property_report combines property detail, AVM valuation, sales history, and tax assessment in a single call. Compound tools collapse 5–15 round-trips into one.
- Meta-tool
-
A gateway-native tool that operates across the entire catalog rather than a single pack. Pipeworx ships seven: ask_pipeworx, discover_tools, resolve_entity, compare_entities, entity_profile, recent_changes, and remember/recall/forget.
- _intel pack
-
A naming convention for compound packs that fan out across multiple data sources for a specific domain — fintech-intel, trade-intel, pharma-intel, govcon-intel, housing-intel. Each _intel pack offers ~6 high-level workflows that combine its underlying sources.
- BYO key
-
Bring Your Own key — for premium sources like ATTOM, Altos Research, or Alpha Vantage, you pass your own API key via the X-API-Key header or ?apikey= query parameter. Public sources (FRED, SEC EDGAR, FDA, Census, BLS, EPA, ClinicalTrials, USPTO, etc.) require no keys at all.
- Context tax
-
The token cost of loading tool definitions into a model's context window for tools the agent never ends up calling. Loading 1,000 tool definitions burns model bandwidth on unused metadata. Pipeworx avoids the context tax by returning only the ~20 most relevant tools per task via discover_tools or vertical scoping.
- _meta
-
Metadata block attached to every Pipeworx tool response, containing cost (credits charged), cache (hit/miss, fresh_until timestamp), suggestions (what to call next based on session history), and alternatives (what to try if a call fails). Agents reason about _meta to decide whether to refetch or self-correct.
- pipeworx:// URI
-
A stable resource URI scheme for citing entities returned by Pipeworx tools — e.g., pipeworx://edgar/company/0000320193/filings or pipeworx://fred/series/UNRATE. Resolvable via the MCP resources/read method, durable across sessions, and safe to embed in agent output as a citation.
Meta-tools
Gateway-native tools that work across the entire catalog.
- ask_pipeworx
-
Routes a natural-language question to the right tool, fills the arguments, executes it, and returns the answer. Best entry point when you do not know which pack or tool to call. Free for all tiers.
- discover_tools
-
Returns the top-20 most relevant tools for a given task description, with full schemas. Replaces the pattern of dumping all tool definitions into context.
- resolve_entity
-
Given a type ("company" or "drug") and value (ticker, name, etc.), returns canonical IDs across packs in one call — CIK + ticker + LEI for companies, RxCUI + brand + ingredient for drugs. Returns ready-to-embed pipeworx:// resource URIs.
- compare_entities
-
Side-by-side comparison of 2–5 entities in parallel. For companies, returns revenue + income + cash + debt with periods. For drugs, returns interactions, indications, and adverse-event summaries.
- entity_profile
-
Fan-out fetch for "everything about this entity" — for a company, returns SEC filings + fundamentals + patents + federal contracts + recent news + LEI in a single round trip across 6 packs.
- recent_changes
-
Time-filtered fan-out — "what is new about this entity in the last N days/months". Accepts since as ISO date or relative shorthand (7d / 30d / 3m / 1y). Returns structured items with total_changes count. Designed for monitoring workflows.
- remember / recall / forget
-
Agent memory across MCP sessions. remember stores a note keyed by topic; recall retrieves notes by topic or search; forget deletes them. State persists on the gateway, keyed to the agent's account or session ID.
Auth & tiers
How access and rate limits are determined.
- Anonymous tier
-
No authentication required. Rate-limited to 50 calls per day per IP address (CF-Connecting-IP). Sufficient for evaluation and casual use. Public data sources only.
- BYO tier
-
Authenticated via X-API-Key header or ?apikey= query parameter — the key is for an upstream paid source (ATTOM, Alpha Vantage, etc.) rather than a Pipeworx account. Rate-limited to 500 calls per day per IP + key hash.
- OAuth tier
-
Free Pipeworx account linked via GitHub OAuth. Bearer token authentication. Rate-limited to 2,000 calls per day per account. Required for verticals.
- Paid tier
-
Stripe-billed Pipeworx subscription. Bearer token authentication. Unlimited calls, metered per call. Includes access to all premium verticals (Housing Intel, FinTech, PharmaPulse, etc.) and team-level features.