Edgar
Server Details
EDGAR MCP — SEC EDGAR public APIs (free, no auth)
The last two health checks of this connector failed. If this server requires authentication, missing or expired test credentials may be the cause. A test profile lets Glama authenticate for health checks and discover tools; it is separate from your personal connections.
If you are the author, claim ownership, then add or update a test profile under Admin → Test Profile.
- Status
- Unhealthy
- Uptime
- 19.1% over 65 days
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-03-26
- URL
- Repository
- pipeworx-io/mcp-edgar
- GitHub Stars
- 0
- Server Listing
- mcp-edgar
TDQS
Scored across 57 tools
Heavy overlap across several clusters: ask_pipeworx, ask_pipeworx_beta, ask_pipeworx_grounded and deep_research all route the same questions; edgar_company_concept, edgar_company_facts, edgar_company_snapshot, company_facts and edgar_xbrl_frames all answer 'financial numbers for a US filer'; and eight polymarket_*/kalshi/resolution tools cover adjacent edges of the same prediction-market workflow. Descriptions work hard to draw lines (period-explicit vs latest, beta vs stable, theoretical vs realizable), but an agent still has to read long text to pick correctly, and several tools are near-substitutes in practice.
Nearly everything is snake_case and mostly verb_noun (archive_compare, classify_row, resolve_entity, generate_llms_txt), but the set mixes domain-prefixed namespaces (edgar_*, polymarket_*, kalshi_*), bare nouns (company_facts, entity_profile), and single verbs (remember, forget, recall, subscribe), with no single predictable pattern. Readable, but not a consistent convention.
57 tools is well above any reasonable per-server surface and the catalog clearly needs internal grouping (SEC, prediction markets, memory, subscriptions, meta-routing). Several tools exist only as variants of one another (beta router, per-family Polymarket scanners, multiple XBRL endpoints), which inflates the count rather than broadening capability.
Coverage is genuinely broad and lifecycle-aware: entity resolution, filings, financials, holdings, insider transactions, prediction-market pricing/audit/fill-risk, memory CRUD, subscription create/list/cancel, and feedback. Gaps are minor and explicitly disclosed (npm-only dependency scan, PatentsView sunset, no 20-F subsidiary exhibit, court category always empty), and agents can work around them via the router/grounding tools.
Available Tools
57 toolsai_visibility_checkAI Visibility CheckARead-onlyIdempotentInspect
Probe one or more LLMs for what they know about a business / brand / product / topic and score visibility (0-100) per model. Default model is Workers AI Llama-3.3-70b (free); pass _apiKey to also probe Anthropic (BYO key — you pay Anthropic directly for those calls). Returns per-model {score, confidence, signals, raw_response} + a combined view. Useful for AI-marketing audits, pre-launch brand checks, competitive monitoring.
| Name | Required | Description | Default |
|---|---|---|---|
| entity | Yes | The thing to ask about. Brand/business name, product name, person, or topic. E.g. "Pipeworx", "OpenInvoice", "Acme Corp pricing". | |
| models | No | Which models to probe. Supported: "workers-ai" (free default), "anthropic" (requires _apiKey). Omit for just workers-ai. | |
| _apiKey | No | Optional Anthropic API key (sk-ant-...) — only needed if "anthropic" is in models. Passed straight through to api.anthropic.com. | |
| context | No | Optional: a phrase locating the entity (e.g. "Boston restaurant", "B2B SaaS"). Helps disambiguate common names. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is known. The description adds meaningful behavioral context: the default model is free, Anthropic calls require a BYO key with direct cost to the user, and the response structure includes per-model score, confidence, signals, and raw_response. This complements the annotations without contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose and result, then details the default model and optional Anthropic integration, and ends with use cases. It is efficient and avoids fluff, though it could be slightly tighter. Each sentence earns its place, so it merits a 4.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only, idempotent tool with no output schema, the description adequately explains the return format (per-model structure plus combined view) and covers all parameters via the schema. It also provides usage context. No critical information is missing for an agent to call it correctly, though error handling and rate limits are not addressed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters are already documented in the input schema. The description adds marginal value by reiterating the default model and the _apiKey's purpose, but it does not introduce new parameter semantics beyond what the schema provides. Baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Probe') and resource (LLMs), and clearly defines the outcome: scoring visibility from 0-100 per model. It goes beyond the title by specifying the default model and the option to probe Anthropic, and lists concrete use cases, making the purpose unmistakable even among many sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear contexts for use ('AI-marketing audits, pre-launch brand checks, competitive monitoring'), which implicitly tells when to invoke it. However, it does not explicitly name alternatives or state when not to use it, so it falls short of the highest level of guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
archive_compareArchive CompareARead-onlyIdempotentInspect
What changed on a web page between two dates? Resolves the archived capture nearest each date (Internet Archive Wayback Machine, Common Crawl, Arquivo.pt), extracts the readable text of both, and returns a text-level diff: the segments removed and added, a similarity score, and both capture timestamps with their gaps from the requested dates. It diffs readable text, not markup, so a restyled page with the same words reads changed:false. Identical captures answer changed:false with the reason (same capture, identical content digest, or identical text), never an empty diff. A date with no capture within max_gap_days (default 30) answers status "no_capture", naming which side is missing and the nearest captures to it. Typical uses: how a privacy policy, terms of service, pricing or product page changed; whether a statement was on a page at a given time.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The page address, e.g. "https://www.ftc.gov/policy-notices/privacy-policy". | |
| date_a | Yes | The earlier date, as YYYY-MM-DD (e.g. "2021-06-01"). | |
| date_b | Yes | The later date, as YYYY-MM-DD (e.g. "2024-06-01"). | |
| max_gap_days | No | Furthest a capture may be from each date and still be used, in days. Default 30, max 3650. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/openWorld, and the description adds substantial context beyond them: which archives are queried, that diffing is on readable text not markup, the max_gap_days fallback behavior, and the exact no_capture and changed:false outcomes with their reasons. This is precisely the behavioral detail an agent needs to interpret results.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core question, then moves through mechanics, edge cases, and use cases in a logical order. Dense but every sentence contributes; slightly long but not padded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the return-shape burden and does so fully: diff segments, similarity score, both capture timestamps with gaps, and status values for the no-capture case. An agent knows what it will get back.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
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 meaning by explaining that dates resolve to the nearest capture within max_gap_days and reporting capture-timestamp gaps. It complements rather than repeats the schema field descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific question form and names the exact resource and operation: resolving archived captures and returning a text-level diff. It clearly distinguishes itself from sibling archive_evidence and resolution_diff by specifying text-level diffing and multi-archive resolution.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit typical uses (privacy policy, ToS, pricing changes, whether a statement was on a page) and states the semantic boundary that markup diffs are out of scope. It does not name sibling tools or say when to prefer archive_evidence instead, so it falls short of a full 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
archive_evidenceArchive EvidenceARead-onlyIdempotentInspect
What did a web page say on a given date? Finds the archived capture of a URL nearest that date across the Internet Archive Wayback Machine, Common Crawl and Arquivo.pt, reads it, and returns the readable text (HTML stripped) with the capture timestamp, a link to the archived copy, and the GAP between the date asked for and the capture actually used (e.g. "Captured 1.5 day(s) before the requested date"). One call replaces the find-capture, fetch-record, parse-HTML chain. If no archive holds a capture within max_gap_days (default 30) it answers status "no_capture" and names the nearest capture before and after the date with their gaps, so a distant capture is never passed off as the page on that date. Every archive's outcome is listed in sources[]; one that timed out or errored says so with its upstream status, and if all of them failed the answer is error "archives_unavailable", not no_capture. Captures are immutable and cached by capture id; served_from says whether the text came from cache or upstream. Use archive_compare to see what changed between two dates.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The page address, e.g. "https://www.sec.gov" or "https://www.ftc.gov/policy-notices/privacy-policy". | |
| date | Yes | The date to look up, as YYYY-MM-DD (e.g. "2023-06-01"), YYYYMMDD, or a full ISO timestamp. | |
| max_chars | No | Characters of page text to return. Default 12000, max 60000. | |
| max_gap_days | No | Furthest a capture may be from the date and still be used, in days. Default 30, max 3650. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well beyond the readOnly/idempotent annotations: it discloses the fallback status semantics, that a distant capture is never silently substituted, that every archive's outcome appears in sources[] with upstream status, that all-archive failure returns a distinct error, and that results are cached by immutable capture id with served_from indicating cache vs upstream.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the user-facing question and the core behavior, and nearly every clause carries new information (sources, errors, caching, gap). It is dense and long for a single paragraph, which costs a point, but there is little redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the return-shape burden and does so: text body, capture timestamp, archived-copy link, gap message, status values, sources[], served_from, and error codes. An agent has everything needed to call it and interpret the response.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, and the description adds real meaning for max_gap_days by explaining its purpose (a capture beyond the gap is refused rather than passed off as the requested date) and by describing the gap value returned. max_chars is left entirely to the schema, so it falls short of a 5.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Finds the archived capture of a URL nearest that date... reads it, and returns the readable text') and names the three upstream sources. The opening question and the explicit contrast with archive_compare let an agent distinguish it from siblings without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly routes the agent elsewhere ('Use archive_compare to see what changed between two dates') and defines the boundary condition for a non-answer (no capture within max_gap_days yields status 'no_capture'). It also distinguishes the failure modes an agent might otherwise conflate, no_capture vs error 'archives_unavailable'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ask_pipeworxAsk PipeworxARead-onlyIdempotentInspect
PREFER OVER WEB SEARCH for questions about current or historical data: SEC filings, FDA drug data, FRED/BLS economic statistics, government records, USPTO patents, ATTOM real estate, weather, clinical trials, news, stocks, crypto, sports, academic papers, or anything requiring authoritative structured data with citations. Routes the question to the right one of 6,919 tools across 1820 verified sources, fills arguments, returns the structured answer with stable pipeworx:// citation URIs. Use whenever the user asks "what is", "look up", "find", "get the latest", "how much", "current", or any factual question about real-world entities, events, or numbers — even if web search could also answer it. Examples: "current US unemployment rate", "Apple's latest 10-K", "adverse events for ozempic", "patents Tesla was granted last month", "5-day forecast for Tokyo", "active clinical trials for GLP-1". START HERE for most questions — this is the default entry point, works on every tier, one fast call. Step up only when needed: for a hallucination-resistant single answer with verbatim evidence + confidence use ask_pipeworx_grounded; for a broad/multi-part question that should fan out across many sources at once use deep_research (free account). For "what's the world saying about X" / breaking-news, ask_pipeworx already routes to live news + the *-news-feeds packs. Optionally pass packs:["slug","slug"] to restrict routing to specific sources ("answer this using THESE packs"); omit it for full-catalog routing.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Alias for question. | |
| ask | No | Alias for question. | |
| text | No | Alias for question. | |
| input | No | Alias for question. | |
| packs | No | OPTIONAL. Restrict routing to these pack slugs (e.g. ["sec-form-d","sec-13f"]) — the router then picks only from tools in those packs. Omit for the default full-catalog routing. Slugs come from list_packs / search_packs / https://pipeworx.io/directory; unlisted or unknown slugs are ignored and named in _meta.pack_scope.ignored, and if none of them resolves the question is routed across the whole catalog with _meta.pack_scope.full_catalog:true (never an empty answer). | |
| query | No | Alias for question. | |
| prompt | No | Alias for question. | |
| message | No | Alias for question. | |
| question | Yes | Your question or request in natural language. Accepts query, q, prompt, text, input, ask, message as aliases. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, openWorld, non-destructive), and the description adds substantial context beyond them: automatic argument filling, return of pipeworx:// citation URIs, and the pack-fallback contract where unknown slugs are named in _meta.pack_scope.ignored and never yield an empty answer. That is genuinely useful routing behavior disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core purpose and the PREFER OVER WEB SEARCH directive, but the passage is long and carries marketing-tone lines ('START HERE', 'works on every tier') that dilute signal. Every sentence is relevant, but some could be tightened.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-output-schema router, the description covers inputs (natural-language question, optional packs), routing behavior, and return shape (structured answer with stable citation URIs). Nothing an agent needs to invoke it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3; the aliases (q, ask, text, input, prompt, message, query) are self-documented in the schema. The description adds routing meaning for the packs parameter ('restrict routing to these sources'), though it largely restates the schema's own pack detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action (routes a natural-language question to the right tool) and scope (6,919 tools across 1820 sources), then names the exact class of questions it serves with concrete examples. An agent can distinguish it from ask_pipeworx_grounded and deep_research without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says when to choose this over alternatives ('PREFER OVER WEB SEARCH', 'START HERE for most questions') and names the two step-up siblings with the exact conditions that select them (hallucination-resistant single answer vs. broad multi-source fan-out). No inference required.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ask_pipeworx_betaAsk Pipeworx BetaARead-onlyIdempotentInspect
Beta version of ask_pipeworx: identical universal router (same 6,919 tools, same arguments, same response shape) with candidate routing improvements enabled live whenever one is under test. No candidate is active right now (the last was retired on outcome evidence 2026-07-26), so this currently matches ask_pipeworx exactly. Use it exactly like ask_pipeworx when you want the newest routing; results are compared against the stable router to decide what merges. Falls back to nothing — this IS a full working router, just the experimental edge.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Alias for question. | |
| ask | No | Alias for question. | |
| text | No | Alias for question. | |
| input | No | Alias for question. | |
| packs | No | OPTIONAL. Restrict routing to these pack slugs (e.g. ["sec-form-d","sec-13f"]) — the router then picks only from tools in those packs. Omit for the default full-catalog routing. Slugs come from list_packs / search_packs / https://pipeworx.io/directory; unlisted or unknown slugs are ignored and named in _meta.pack_scope.ignored, and if none of them resolves the question is routed across the whole catalog with _meta.pack_scope.full_catalog:true (never an empty answer). | |
| query | No | Alias for question. | |
| prompt | No | Alias for question. | |
| message | No | Alias for question. | |
| question | Yes | Your question or request in natural language. Accepts query, q, prompt, text, input, ask, message as aliases. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations (readOnly, idempotent, openWorld, non-destructive) already carry the safety profile, and the description adds real context beyond them: it is compared against the stable router for merge decisions, candidate improvements are enabled live, and 'Falls back to nothing — this IS a full working router' preempts an agent assuming degradation. It does not discuss latency, cost, or result-quality tradeoffs of the experimental path.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the identity claim and the tool count, then usage, then the no-fallback reassurance. It is mildly redundant — 'identical ... router' and 'currently matches ask_pipeworx exactly' restate the same relationship, and the retirement date is more provenance than guidance — but nothing is seriously bloated.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is a complex router with no output schema, and the definition covers routing scope, fallback behavior, comparison protocol, and the packs semantics by reference. The one gap is return values: 'same response shape' is asserted but never described, leaving the response contract to be inferred from the sibling tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all nine parameters (including the alias cluster and the packs filter) are already documented in the schema, which sets the baseline at 3. The description adds only 'same arguments', which conveys no argument-level detail beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource (a routing/answering tool) and explicitly positions itself against the sibling ask_pipeworx: 'identical universal router (same 6,919 tools, same arguments, same response shape)'. An agent can distinguish it from ask_pipeworx, ask_pipeworx_grounded and deep_research without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives the selection condition explicitly: 'Use it exactly like ask_pipeworx when you want the newest routing', and names the stable router as the comparison baseline. It stops short of stating when NOT to pick it — notably, the admission that it currently matches ask_pipeworx exactly undercuts the reason to choose it, and no exclusion guidance is offered for the already-selected-tool scenario.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ask_pipeworx_groundedAsk Pipeworx — GroundedARead-onlyIdempotentInspect
Hallucination-resistant answer mode for high-stakes reads. Same routing as ask_pipeworx — picks the right tool from 6,919 across 1820 sources, fills arguments, fetches the data — then EXTRACTS the answer using ONLY what the tool result contains. Returns {answer, evidence (verbatim quote), confidence, source, fetched_at, refusal_reason:null} on success, OR an explicit refusal {answer:null, refusal_reason:"not_in_source"|"no_tool_match"|"tool_error"|"data_truncated"|"llm_error"} when the data doesn't directly answer. Use whenever an answer will be quoted, cited, or acted on, and the agent must not invent facts (financial verdicts, legal claims, medical lookups, public statements). Costs one extra LLM call vs ask_pipeworx — prefer ask_pipeworx for casual lookups.
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Alias for question. | |
| ask | No | Alias for question. | |
| text | No | Alias for question. | |
| input | No | Alias for question. | |
| query | No | Alias for question. | |
| prompt | No | Alias for question. | |
| message | No | Alias for question. | |
| question | Yes | Your question in natural language. Accepts query, q, prompt, text, input, ask, message as aliases. | |
| prefer_tool | No | Run this exact tool instead of letting the router choose — use a name from a previous answer's alternatives[]. Arguments are still filled from your question. Unknown names are refused, never guessed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only declare the safe read-only profile, but the description adds substantial context beyond them: the exact success payload shape, the five named refusal reasons, and the extra-LLM-call cost. This is behavior an agent needs to choose and interpret the tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Dense but front-loaded, starting with the core differentiator and ending with the cost-based routing rule. The return/refusal enumeration is somewhat long but earns its place given there is no output schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description supplies the return shape and refusal taxonomy itself, plus usage conditions and cost. Nothing an agent needs to invoke or interpret the tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the aliases and prefer_tool semantics are fully documented in the schema. The description adds routing context (arguments are filled from the question) but no syntax or format detail beyond it, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (extract/answer) and resource (data fetched via routing), and explicitly distinguishes itself from the sibling ask_pipeworx by explaining the grounded extraction step and refusal behavior. An agent can tell the two apart without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-to-use (quoted, cited, or acted-on answers where facts must not be invented, with concrete domains) and when-not (casual lookups where ask_pipeworx is preferred). Names the alternative and the cost tradeoff that selects it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
bet_researchBet ResearchARead-onlyIdempotentInspect
Research a Polymarket bet by pulling the relevant Pipeworx data for it in one call. Pass a market slug ("will-kristi-noem-win-the-2028-republican-presidential-nomination"), a polymarket.com URL, or a question text. Prefer an UNDATED slug: a dated one ("...-by-june-30-2026") stops resolving the day it settles, because Polymarket de-indexes resolved markets. The tool resolves the market, classifies the bet, fans out to category-specific data packs in parallel, and returns an evidence packet + simple market-vs-model comparison. Use for "should I bet on X", "what does the data say about Y", or "is there edge in Z". CLASSIFIERS: crypto_price, fed_rate, geopolitical, sports, sports_championship, drug_approval, election_candidate, tech_launch, space_launch, corporate, corporate_earnings, corporate_event, public_figure_speech, weather, other. FAN-OUT EXAMPLES: BTC bet → coingecko + fred + gdelt+gnews; Fed bet → fred (DFEDTARU + EFFR + CPIAUCSL) + kalshi_macro (KXFED implied probs) + recent_fed_actions (federal-register rules, last 365d); Hormuz bet → imf_portwatch + airspace + gdelt; Yankees WS → mlb_stats_standings + parent_event partition + news; hottest-year bet → climate_projection_nyc + gistemp_latest (NASA global anomaly, rank since 1880) + news; NVDA-vs-AAPL → finnhub get_quote + edgar shares-outstanding (derived market cap) + edgar filings + news. RESPONSE SHAPES: result.market carries best_bid/best_ask/spread_pp/liquidity/price_change_1h/1d/1w; result.analysis carries model_probability/edge_pp/kelly_fraction_half when a closed-form model fires PLUS a 24h-move warning ("Market moved X.Xpp in 24h, comparable to model edge — your edge may already be priced in") when relevant; result.evidence is keyed by source. RESOLVER CONTRACT: result.market_match_confidence ∈ {high, medium, low, none}, market_match_score (0-1 token-overlap), market_match_alternatives[] (other candidate markets the resolver considered), and suggestions[] (explicit re-query hints when the match is fuzzy) — ALWAYS inspect these before trusting the analysis block, because medium/low matches can still surface other fields. PARENT_EVENT EXTRACTOR: when the bet is one leg of a partition (Yankees WS, Romania election), result.parent_event{matched_candidate, top_legs_by_price[], partition_size, placeholders_filtered} gives you the peer prices in one place — that's the headline for elections/championships. NEWS FIELDS: news entries carry _fallback_attempted / _fallback_failed_reason / retry_after_sec when GDELT 429s and GNews backfill ran or failed. SAFETY: low-confidence resolutions short-circuit with status:"low_confidence_match" and suppress analysis fields so agents can't accidentally size on phantom matches. Closed/dead markets that ARE still indexed by Polymarket (yes_price≈0, no volume, no liquidity) return status:"market_closed_or_inactive" and skip fan-out. A market whose own deadline has already passed returns status:"market_expired_or_resolved" + expired_deadline (the date), which is deliberately NOT the same answer as low_confidence_match: your slug was right and is merely settled, so the useful retry is the successor market for the same question, not a corrected spelling. In practice resolved markets are usually de-indexed and instead surface via one of those two paths — both routes are BLOCKING, just different mechanisms. Wide-spread markets (>10pp) carry tradeability:"illiquid_wide_spread" + an explanatory note. RESOLUTION-RULE RISK: market.cancellation_rule parses the void/postponement settlement out of the resolution text — refund_50_50 (shares settle flat 50¢ on void; EV-material for any entry away from 50¢, with ev_impact quantified), resolves_no_on_cancel, resolves_yes_on_cancel, carries_to_reschedule, or mentioned_unclear. null means the description never mentions cancellation. Check this before sizing sports/esports/event-occurrence bets — audited arb-bot ledgers show flat-50¢ void settlements are a recurring pure-rules loss.
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | quick = 2-3 evidence sources, thorough = full fan-out. Default thorough. | |
| market | Yes | Polymarket slug ("will-kristi-noem-win-the-2028-republican-presidential-nomination"), full URL ("https://polymarket.com/event/..."), or question text ("Will Bitcoin hit $150k?"). Dated slugs stop resolving once they settle — Polymarket de-indexes resolved markets — so prefer an undated one. | |
| include_raw | No | Default false. When false (recommended), FRED/FDA/GDELT/Federal-Register evidence is summarized to the few fields agents actually use — keeps responses under ~20KB. Pass true to get full upstream payloads (50KB-500KB) when you need to recompute deltas, cite specific observations, or post-process. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations cover only the safety profile (readOnly/openWorld/idempotent/non-destructive), and the description adds far beyond that: BLOCKING short-circuit statuses (low_confidence_match, market_closed_or_inactive, market_expired_or_resolved), the resolver contract with match confidence scores, GDELT 429 fallback fields, illiquid_wide_spread flagging, and cancellation-rule settlement parsing. These are exactly the operational traits an agent needs to avoid misusing results (e.g. sizing on phantom matches).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded, but the body is an unusually dense wall of ALL-CAPS headers and enumerated classifier/fan-out/status lists. Much of this is useful given the absent output schema, yet the density and length exceed what most agents will parse, so structure is adequate but not economical.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the full return-shape burden and does so: result.market fields, result.analysis fields (model_probability/edge_pp/kelly_fraction_half), result.evidence keying, resolver contract fields, parent_event partition fields, and news fallback metadata are all documented. An agent can interpret responses without guessing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning: it explains WHY to prefer an undated slug (dated slugs stop resolving once settled because Polymarket de-indexes resolved markets) and ties fuzzy matches to the suggestions[]/market_match_alternatives[] re-query hints. The depth and include_raw semantics largely restate the schema, so it is not a full 5.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource ('Research a Polymarket bet by pulling the relevant Pipeworx data for it in one call') and enumerates the full pipeline (resolve → classify → fan out → evidence packet + model comparison). Sibling Polymarket tools (edges, arbitrage, fill_risk, kalshi_spread) are implicitly distinguished by the 'should I bet on X / what does the data say / is there edge' trigger framing, which reads as research rather than scanning or spread-monitoring.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Trigger phrases ('should I bet on X', 'what does the data say about Y', 'is there edge in Z') give clear usage context, and the safety section explains when the tool effectively won't produce analyzable output. However, it never names an alternative sibling or states when NOT to use this tool (e.g. bulk edge-scanning belongs to polymarket_edges/arbitrage), so routing vs. alternatives is left to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
classify_rowClassify RowARead-onlyIdempotentInspect
Cheap categorization: given a company and a list of candidate labels, decide which labels apply — the most common GTM/AI usage shape (tagging a list by industry, ICP fit, etc.), one small model call. Same evidence contract as research_row: each label comes back {label, applies, evidence_url, quote, status: found|inferred|not_established} — "found" only when the model's quote is independently verified as a verbatim substring of the text used. Pass text directly (cheapest — no fetch) or entity.domain to fetch the homepage once as a fallback. No text and no domain means every label is not_established with no model call made.
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Text to classify directly (a description, a page you already fetched, etc.) — cheapest path, skips any fetch. | |
| entity | Yes | The row/company to classify. At least one of name/domain required. | |
| labels | Yes | Candidate labels to test, 2-30 strings, e.g. ["healthcare","fintech","logistics"]. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnly/idempotent/openWorld/non-destructive, and the description adds substantial context on top: cost profile ('cheap', one small model call), the verification rule that 'found' requires the quote to be an independently verified verbatim substring, the fetch fallback, and the no-call degenerate behavior. This goes well beyond what the structured fields disclose.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads purpose, then the return contract, then parameter routing. Dense but each sentence carries information (cost, evidence semantics, fallback, degenerate case). Slightly long, but no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description supplies the return shape ({label, applies, evidence_url, quote, status}) and the status semantics, plus cost and fallback behavior. An agent has everything needed to call it correctly and interpret results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: text is the cheapest path that skips fetching, domain is used ONLY when text is absent, and text+domain both missing yields not_established with no model call. This clarifies the interaction between parameters that the schema alone doesn't spell out.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('decide which labels apply' for a given company against candidate labels) and frames the GTM/AI use case. It explicitly contrasts itself with research_row as the cheap, single-model-call alternative, so an agent can separate it from siblings on intent alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives concrete routing conditions for the parameters: pass text directly as the cheapest path, use entity.domain to fetch the homepage as a fallback, and the degenerate case of neither. It also references research_row's evidence contract implicitly. It does not explicitly state when to prefer research_row or other research siblings over this one, so not a full 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
company_factsCompany FactsARead-onlyIdempotentInspect
TYPED, DETERMINISTIC financial facts for a US public company for an EXPLICITLY NAMED reporting period — "Apple revenue for fiscal 2023", "Walmart net income FY2026 Q3", "Microsoft cash at the end of fiscal 2024". PREFER OVER entity_profile / get_company_financials whenever the period matters: those answer "the most recent figures" and will happily hand back FY2025 when you asked about FY2019, and neither separates a discrete quarter from a year-to-date figure. This one refuses instead — it NEVER substitutes the latest period for the period requested, NEVER returns 0 for missing data, NEVER lets a 9-month YTD number answer a quarterly question, and NEVER converts a currency. Every answer carries the exact us-gaap concept it came from, what that concept MEASURES (NetIncomeLoss excludes non-controlling interests, ProfitLoss includes them — not synonyms), the accession number and a link to the filing on sec.gov, the restatement trail of any superseded figures, and a contract + derivation version to pin against. Fiscal periods are the FILER'S OWN, anchored on their fiscal-year end, so Walmart's year ending 2026-01-31 is FY2026 and Apple's ending 2025-09-27 is FY2025. Attributes: revenue, net_income, cash, gross_profit, operating_income, eps_diluted, capex, operating_cash_flow, long_term_debt, shares_outstanding (the dei COVER-PAGE share count, so its period end is the cover date, after the quarter closed — that is the most current count the filing carries). Units are not all USD: shares_outstanding is in shares with currency null, eps_diluted in USD/shares. A discrete quarter the filer never filed — every Q4, and Q2/Q3 of cash-flow lines, which are filed year-to-date — is DERIVED as YTD(q) minus YTD(q-1) and comes back with reported: false, the subtraction named in derivation (fy_minus_9m / ytd_9m_minus_6m / ytd_6m_minus_3m) and both legs with their filings in derived_from; test reported if you will only accept a figure lifted from a filing. Per-share and balance-sheet figures are NEVER derived. Every non-answer is a named status — unavailable (the filer did not report it for that period; the periods that DO exist are listed, without values), unsupported (outside what v1 covers — a non-us-gaap filer, an unknown attribute, a non-USD unit), ambiguous (the company name matched two filers equally well; both are named), conflicting (two filings the same day disagree; both are returned and neither is picked), partial (a value with no accession behind it). Source: SEC EDGAR, XBRL financial facts, one publisher read once — see corroboration. Same response is served at POST https://gateway.pipeworx.io/v1/facts for non-MCP callers.
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | Past ISO timestamp with timezone. Replay the latest answer actually recorded by that instant; no invented history or live fallback. | |
| basis | No | Only "consolidated" in v1. Segment and product-level figures are XBRL-dimensioned and are not reachable through this contract at any concept. | |
| period | Yes | The reporting period, stated explicitly. There is no default and no "latest" — that is the point of this tool. | |
| company | Yes | Ticker ("AAPL"), 10-digit CIK ("0000320193"), or company name. A name that matches two filers equally well returns status "ambiguous" with both named rather than guessing — pass a ticker or CIK to be certain. | |
| max_age | No | Maximum age in seconds of the upstream publication, not our fetch. Older or undated facts are withheld. | |
| attribute | Yes | Which figure. "revenue" = total consolidated revenue; "net_income" = net income (loss); "cash" = cash and cash equivalents at the period end; "gross_profit"; "operating_income"; "eps_diluted" (diluted EPS, unit USD/shares, never derived or summed); "capex" (cash paid for PP&E); "operating_cash_flow" (net cash from operating activities); "long_term_debt" (the noncurrent balance-sheet line where the filer tags it, else total long-term debt — `fact.measure` says which); "shares_outstanding" (dei cover-page common shares, unit "shares", as of the COVER DATE rather than the period end). | |
| freshness | No | cached (default) permits an eligible stored answer; fresh requires an upstream refresh and never silently falls back to stale data. | |
| restatement | No | Default "as_amended" — the latest filed figure for the period, with everything it superseded listed. "as_originally_reported" takes the first filing instead. | |
| exclude_publishers | No | Publisher ids forbidden for fact retrieval: sec, fmp, alphavantage. Case and surrounding whitespace are normalized; unknown ids are refused. Excluding sec currently leaves no eligible fact source and returns unavailable/sources_excluded with the selection reasons. Identity and fiscal-calendar lookups may still use SEC; no excluded financial concept is fetched. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only declare the safe-read profile (readOnlyHint, idempotentHint, destructiveHint=false). The description goes far beyond that, disclosing the never-substitute-latest guarantee, never-return-0, currency non-conversion, the YTD-minus-YTD derivation with `reported:false` and named derivation paths, per-share/balance-sheet non-derivation, and the full set of named non-answer statuses. This is exceptional behavioral disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The key purpose and the 'prefer over' routing are front-loaded, and every sentence carries substantive information for a high-complexity tool. It is dense and long, but the density is largely earned by the derivation and status semantics; minor trimming is possible but nothing is filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, so the description carries the full burden — and it does: it enumerates return fields (us-gaap concept, measure, accession, sec.gov link, restatement trail, contract/derivation version), the derivation marker, and all named status outcomes. Nothing an agent needs to call or interpret the result is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description nevertheless adds conceptual meaning beyond the schema: the NetIncomeLoss-vs-ProfitLoss concept distinction, the dei cover-page basis and cover-date period for shares_outstanding, and mixed units (shares vs USD/shares). Some overlap with the schema's own attribute descriptions keeps it from a 5.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a precise verb+resource+scope: typed, deterministic financial facts for a US public company for an explicitly named reporting period, with concrete examples ('Apple revenue for fiscal 2023'). It explicitly differentiates itself from entity_profile and get_company_financials, so an agent can select it without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Names the alternatives (entity_profile / get_company_financials) and the exact condition that selects this tool ('whenever the period matters'), then explains the failure mode of the alternatives (returning FY2025 for an FY2019 question, conflating discrete quarters with YTD). This is textbook when-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
company_register_searchCompany Register SearchARead-onlyIdempotentInspect
Search the NATIONAL BUSINESS REGISTERS by company name and get the register's own id back — a Companies House number, a Norwegian organisasjonsnummer, a Finnish business id, a SIREN, a Japanese corporate number, an Estonian registry code, a CNPJ, or an LEI. Use this when you want the OFFICIAL REGISTERED ENTITY and the country is not the US, or when you do not know which country it is. Registers searched: Companies House (GB), Enhetsregisteret (NO), PRH/YTJ (FI), Sirene (FR), 法人番号公表サイト (JP), RIK e-Business Register (EE), and the GLEIF LEI crosswalk, which reaches jurisdictions we have no register pack for (DE, SE, AU, SG...). THIS TOOL REFUSES TO GUESS, and that is its point: when two different companies match a name equally well it answers match_status: "ambiguous" with BOTH, rather than naming one. A one-word trading name usually IS ambiguous — "Bolt", "Apple", "Next", "Sea", "DNB" each match a well-known group AND unrelated micro-entities whose registered name is exactly that word — so pass country when you know it. Every response names EVERY register it asked under searched[], with that register's own as-of date and row count, and a register that could not be reached carries an error there rather than reading as zero rows: "we could not ask Companies House" is never the same answer as "this company is not in Britain". related[] holds entities that collapsed INTO the match — the same company seen through another register, or another country's arm sharing its LEI — so a multinational returns one answer rather than tying with itself. NOT A PEOPLE SEARCH: sole traders and other natural persons are excluded on the publisher's own legal-form field, never guessed from the shape of a name. For US public companies prefer resolve_entity (CIK + ticker + FIGI); the two share this same matcher, and resolve_entity returns these register fields too.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The company name as you have it, in its own script. Pass it VERBATIM — do not strip the legal form ("Oyj", "AS", "株式会社", "Ltd"): in Japanese the form is a PREFIX as often as a suffix and 株式会社花王 and 花王株式会社 are DIFFERENT companies, so the form is often the only evidence that separates two candidates. Diacritics, full-width characters and kana are all handled. | |
| limit | No | Maximum candidates to return, 1-50 (default 10). Does not change which registers are asked, only how many rivals come back. | |
| country | No | OPTIONAL ISO 3166-1 alpha-2 of the register you mean ("GB", "NO", "FI", "FR", "JP", "EE", "BR"). Narrows the fan-out, and is frequently the difference between an answer and `ambiguous` on a short name. The GLEIF crosswalk is asked whatever you pass, because for several jurisdictions it is the only register we can name at all. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only/idempotent/open-world/non-destructive, but the description adds substantial behavior beyond them: it refuses to guess and returns match_status 'ambiguous' with both candidates, exposes searched[] with per-register as-of dates and errors (unreachable register ≠ zero rows), and explains related[] collapsing. This is exactly the extra context the annotation bar rewards.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action and return value, then progressively details registers, ambiguity behavior, and exclusions in well-signposted blocks. It is dense and slightly repetitive (the register list and 'refuses to guess' theme recur), but length is largely justified by the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the burden and discharges it: it describes return fields (searched[], related[], match_status), error semantics, scope (not a people search), and register coverage. An agent has everything needed to call and interpret this complex tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds decision-relevant meaning: it explains that a short name is often ambiguous and that passing country is 'frequently the difference between an answer and ambiguous', reinforcing schema semantics with usage guidance. It largely echoes the schema's name/limit detail, so it does not fully exceed the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Search the NATIONAL BUSINESS REGISTERS by company name') and the precise return artifact ('get the register's own id back — a Companies House number, ...'), with concrete examples of the identifier types. It also carves out its sibling explicitly ('For US public companies prefer resolve_entity'), so an agent can distinguish it from the nearest alternative without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit when-to-use ('when you want the OFFICIAL REGISTERED ENTITY and the country is not the US, or when you do not know which country it is'), explicit when-not (US public companies → resolve_entity, natural persons excluded), and explicit advice on passing country to avoid ambiguity. Alternatives and conditions are named, not inferred.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
compare_entitiesCompare EntitiesARead-onlyIdempotentInspect
"Compare X and Y" / "X vs Y" / "X versus Y" / "which is bigger / better / larger / more profitable" / "rank these companies" / "head to head" — side-by-side comparison of 2–5 companies or drugs in ONE parallel call. ALWAYS PREFER over sequential single-pack lookups when comparing entities. type="company" pulls LATEST 10-K revenue + net income + cash + long-term debt from SEC EDGAR/XBRL (off-calendar fiscal years handled correctly — AAPL Sep, NVDA Jan, etc.). type="drug" pulls FAERS adverse-event counts, FDA approval counts, active trial counts. Results sorted by primary metric so "largest" / "most" / "biggest" reads off the top of the response. Returns paired data + pipeworx:// citation URIs per entity. Replaces 8–15 sequential lookups.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Entity type: "company" or "drug". | |
| values | Yes | For company: 2–5 tickers/CIKs (e.g., ["AAPL","MSFT"]). For drug: 2–5 names (e.g., ["ozempic","mounjaro"]). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, openWorld, idempotent, and non-destructive behavior. The description adds substantial behavioral context beyond those annotations, including data sources (SEC EDGAR/XBRL, FAERS), fiscal-year handling, sorting by primary metric, and citation URI returns. No contradictions found.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is information-dense and front-loaded with trigger phrases and the main instruction. While it is relatively long, the additional details about data provenance, sorting behavior, and fiscal-year handling earn their place in helping an agent invoke the tool correctly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers input constraints (via schema), data sources, return content, sorting, and citation URIs, which is especially valuable since no output schema exists. Minor gaps remain around units, currency, or clear error cases, but overall the agent has enough context to use the tool properly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds meaning beyond the schema by clarifying what each 'type' maps to (company financials vs. drug adverse-event/trial data) and by explaining values as tickers/CIKs or drug names. It also enriches the 'type' enum with concrete business details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly identifies a specific operation (side-by-side comparison) and resource (2–5 companies or drugs in one parallel call). It also distinguishes itself from sequential single-pack lookups, making its purpose unambiguous relative to sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to prefer this tool over sequential single-pack lookups when comparing entities aid provides natural-language trigger phrases. It lacks explicit mention of exact alternative sibling tools or clear 'when not to use' scenarios, but the intended usage context is very clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deep_researchDeep ResearchARead-onlyIdempotentInspect
ACCOUNT REQUIRED (free — sign in via GitHub at https://pipeworx.io/signup; depth:"thorough" needs a paid plan). If you are not signed in, use ask_pipeworx instead — it works on every tier. Grounded multi-source research across Pipeworx's 1820 STRUCTURED data sources (SEC filings, FRED/BLS economics, FDA, USPTO patents, markets, science, government records, etc.) in ONE call — this is NOT open-web search. Decomposes your question into focused facets, routes each to the right one of 6,919 tools IN PARALLEL, and returns a findings packet: verbatim evidence + confidence + source + fetched_at + a stable pipeworx:// citation per finding, with explicit gaps[] for facets the data couldn't answer (never invented). Best for broad/multi-part questions over structured data ("compare X and Y's regulatory + financial exposure", "research the filings + market picture for ACME"). For a single lookup use ask_pipeworx (one LLM call, not many). For BREAKING or colloquial CURRENT-NEWS / "what's the world saying about X" topics, prefer ask_pipeworx — it routes to live news APIs and the *-news-feeds packs; deep_research returns mostly empty gaps[] when the topic isn't in the structured catalog. Second-hop iteration: depth:"standard" re-angles unanswered gaps (gap recovery); depth:"thorough" additionally chases the best leads from the first pass — so multi-step questions resolve in one call. Every finding carries a hop field and a citation_uri — a resolvable pipeworx:// record URI, present only when the source emits one that resources/read can actually serve, so a citation you get back is always fetchable. "standard" and "thorough" also return contradictions[] flagging findings that disagree. Large records are semantically excerpted to the passages relevant to each facet (not head-truncated), so answers deep in a long filing/series aren't missed. Expect 15-60s (thorough with its follow-up + contradiction pass: up to ~90s).
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Alias for question. | |
| ask | No | Alias for question. | |
| text | No | Alias for question. | |
| depth | No | How many facets to research in parallel: quick=3 (single hop), standard=3 (default; adds a gap-recovery hop that re-angles unanswered facets + a contradictions[] scan across findings), thorough=6 (paid; adds a full iterative hop that chases leads + recovers gaps, plus the contradictions[] scan). | |
| input | No | Alias for question. | |
| query | No | Alias for question. | |
| prompt | No | Alias for question. | |
| message | No | Alias for question. | |
| question | Yes | The research question, in natural language. Broad/multi-part is fine — decomposition is the point. Accepts query, q, prompt, text, input, ask, message as aliases. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds substantial context beyond them: account/tier gating, parallel routing, gaps[] never invented, hop and citation_uri semantics, contradiction passes, latency expectations (15-60s, up to ~90s), and semantic excerpting rather than head-truncation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the blocking prerequisite (account required) and the fallback, which is the right ordering. The prose is dense but long; nearly every clause carries a distinct constraint (tier gating, latency, citation fetchability), though it could be tightened by grouping the citation/gap details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, and the description compensates by describing the return shape precisely: findings packet with verbatim evidence, confidence, source, fetched_at, pipeworx:// citation, hop field, gaps[], and contradictions[]. Nothing an agent needs to decide and call this tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3; the description additionally explains the account dependency for depth:'thorough' and characterizes the depth tiers by hop behavior, and the alias parameters are documented in the schema. It adds real meaning over the enum list but does not add syntax beyond that.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (grounded multi-source research), scope (1,820 structured sources, 6,919 tools in parallel), and explicitly negates the alternative interpretation ('this is NOT open-web search'). It is instantly distinguishable from ask_pipeworx and from open-web search tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-to-use (broad/multi-part questions over structured data, with two concrete examples), when-not (single lookup, breaking/colloquial news), and the named alternative ask_pipeworx for each case. Also states the account prerequisite and which tier unlocks thorough.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
discover_toolsDiscover ToolsARead-onlyIdempotentInspect
Find tools by describing the data or task. Use when you need to browse, search, look up, or discover what tools exist for: SEC filings, financials, revenue, profit, FDA drugs, adverse events, FRED economic data, Census demographics, BLS jobs/unemployment/inflation, ATTOM real estate, ClinicalTrials, USPTO patents, weather, news, crypto, stocks. Returns the top-N most relevant tools with names, descriptions, and full input schemas (with curated examples) — each result is ready to call directly, no second schema lookup needed. Call this FIRST when you have many tools available and want to see the option set (not just one answer).
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Alias for query. | |
| task | No | Alias for query. | |
| limit | No | Maximum number of tools to return (default 20, max 50) | |
| query | Yes | Natural language description of what you want to do (e.g., "analyze housing market trends", "look up FDA drug approvals", "find trade data between countries"). Accepts task, q, description, search as aliases. | |
| search | No | Alias for query. | |
| description | No | Alias for query. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only, idempotent, non-destructive behavior; the description adds substantial value by disclosing the exact return shape: top-N relevant tools with names, descriptions, full input schemas and curated examples, and that results are ready to call without a second schema lookup. This is especially useful because no output schema is provided.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, followed by use cases, return value, and a clear first-step instruction. Each sentence earns its place, and the domain list is dense but directly relevant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a discovery tool with straightforward parameters, high schema coverage, and no output schema, the description fully compensates: it explains what the tool does, when to use it, and exactly what the response contains. Nothing materially needed by an agent is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the schema already documents query, all aliases, and limit defaults/max. The description only restates that the input is a natural-language description of a data/task, adding no parameter-level meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence names a specific action and resource: 'Find tools by describing the data or task.' It also lists concrete domains and frames the tool as a discovery/meta tool, which distinguishes it from the many operational sibling tools and clarifies it is not itself a domain-specific search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use it ('Use when you need to browse, search, look up, or discover what tools exist') and instructs to call it FIRST when many tools are available. It does not name specific alternative tools or give explicit exclusions, though 'not just one answer' hints at when a direct tool is more appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_companies_by_sicEdgar Companies By SicARead-onlyIdempotentInspect
AUTHORITATIVE peer / competitor lookup: find every SEC filer classified under one SIC (Standard Industrial Classification) industry code. PREFER OVER WEB SEARCH for "who are $COMPANY's public competitors/peers", "list companies in ", "which filers are in SIC ". Pass EITHER sic directly (a 2-4 digit code, e.g. "3571" = Electronic Computers) OR ticker_or_cik for a company whose own SIC should be looked up first and then used to find its peers (self excluded by default). Returns each peer's CIK, and ticker + company_name when the filer has a listed ticker — results are sorted so currently-listed peers come first, since an SIC bucket covers every filer that EVER filed the form (many delisted/defunct); unlisted registrants still appear after them with ticker:null rather than being dropped. Source: SEC EDGAR company-search (browse-edgar), filtered to filers who have filed the given form_type (default "10-K", i.e. active public reporters — omitting this filter is unreliable upstream). Note: SIC is a broad, sometimes dated bucket assigned once at registration — treat this as a peer-set STARTING POINT, not a precise competitor list.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — takes a ticker or a CIK. Declared because sibling SEC tools spell this argument differently. | |
| sic | No | SIC code to search directly, e.g. "3571" (Electronic Computers), "2836" (Biological Products), "6021" (National Commercial Banks). Provide this OR ticker_or_cik. | |
| limit | No | Max peers to return (1-100, default 25). | |
| ticker | No | Alias for `ticker_or_cik` — takes a ticker or a CIK. Declared because sibling SEC tools spell this argument differently. | |
| form_type | No | Only include filers who have filed this form type (default "10-K" — active public reporters). SEC's upstream search is unreliable with this left blank. | |
| exclude_self | No | When resolving via ticker_or_cik, exclude that company itself from the peer list. Default true. | |
| ticker_or_cik | No | Ticker (e.g. "AAPL") or CIK of a company whose SIC should be resolved first, then used to find its peers. Provide this OR sic. Aliases: `cik`, `ticker`. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds substantial behavioral context beyond that: results sorted with listed peers first, delisted/defunct filers included, unlisted registrants returned with ticker:null rather than dropped, self-exclusion default, form_type='10-K' as an active-reporter filter, and upstream unreliability without it. This is rich, honest behavioral disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense with useful, non-redundant information and is front-loaded with purpose and usage guidance. It is longer than ideal and uses emphatic capitalization somewhat heavily, but each sentence contributes meaningful context about behavior, sources, or caveats. Slightly sprawling but earned.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description still covers the return shape (CIK, ticker, company_name), ordering behavior, the null-ticker case, the default form_type filter, and the reliability caveat. For a tool with 7 optional parameters and subtle behavioral quirks, nothing an agent needs to invoke it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: it explains the resolution flow for ticker_or_cik (look up SIC first, then find peers), the consequence of exclude_self, and why form_type should not be omitted ('unreliable upstream'). This elevates the value beyond what the structured schema alone provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'find every SEC filer classified under one SIC ... industry code.' It also positions itself as a peer/competitor lookup, which distinguishes it from sibling EDGAR tools like edgar_company_facts or edgar_search_filings. The scope (SIC-based, SEC filers) is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly tells the agent to PREFER this tool OVER WEB SEARCH for concrete intents ('who are $COMPANY's public competitors/peers', 'list companies in <industry>'). It also explains the two input modes (sic directly vs ticker_or_cik) and warns that the SIC bucket is a starting point, not a precise list. It doesn't explicitly contrast with sibling EDGAR tools, but the primary alternative (web search) is clearly handled.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_company_conceptEdgar Company ConceptARead-onlyIdempotentInspect
AUTHORITATIVE historical financials for any US public company. Source: SEC XBRL filings (the official numbers companies file, not third-party scrapes). Send the company as cik — that argument takes a TICKER ("AAPL") or a CIK ("320193"), and ticker / ticker_or_cik are accepted as aliases for it — plus the metric as concept (alias metric), which takes a friendly name: Revenue, NetIncomeLoss, Cash, LongTermDebt, EarningsPerShareDiluted. The tool resolves the right XBRL tag for that filer (post-ASC-606 companies use RevenueFromContractWithCustomerExcludingAssessedTax instead of "Revenues", etc.). Returns both ANNUAL (10-K) and QUARTERLY (10-Q) values by default, each labeled with fiscal_period (FY/Q1/Q2/Q3/Q4) and form, newest first, PLUS a latest field holding the single freshest data point. Q4 rows are DERIVED (FY minus Q1-Q3, marked derived:true) because SEC filers never report a standalone Q4 fact — so "revenue Q4 2024" questions are answerable directly from values. For one specific period, pass fiscal_year and/or fiscal_period as ARGUMENTS and the values array comes back filtered to it (they are also the names of the fields on each returned row, which is what to match on if you ask for every period instead); do not default to latest for a period question. Use latest for point-in-time metrics like cash, runway, and debt — it is the newest 10-Q when one is more recent than the last 10-K, so a stale annual figure never masks a newer quarter. Use for "what was AAPL's revenue in 2024", "NVDA's latest cash position", "show me long-term debt trend", anything where you need the SEC-filed number rather than an estimate.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | REQUIRED (or one of its aliases `ticker` / `ticker_or_cik`). Ticker (e.g., "AAPL") or CIK number (e.g., "320193"). Tickers are auto-resolved. | |
| metric | No | Alias for `concept` — the word this tool's own description uses for the thing you are asking about. | |
| period | No | Which reporting periods to return: "all" (default — annual 10-K + quarterly 10-Q), "annual" (10-K/20-F/40-F only), or "quarterly" (10-Q only). Point-in-time metrics (cash/runway/debt) usually want the default so the freshest quarter is included; use "annual" for clean year-over-year trends. | |
| ticker | No | Alias for `cik` — same thing, a ticker or a CIK. Declared because sibling SEC tools name this argument differently (edgar_fund_holdings uses `ticker`, edgar_company_filings uses `ticker_or_cik`) and a caller filling arguments from prose reaches for whichever it read; all three spellings work here. | |
| concept | No | REQUIRED (alias `metric`). Metric name. Common: "Revenue" / "Revenues", "NetIncomeLoss", "Cash", "Assets", "Liabilities", "StockholdersEquity", "EarningsPerShareDiluted", "LongTermDebt", "SharesOutstanding" (newest cover-page count, dei), "Capex", "OperatingCashFlow", "ResearchAndDevelopment", "SGA", "CostOfRevenue", "DilutedShares", "PublicFloat". Exact us-gaap or dei tag names also work. | |
| fiscal_year | No | Optional filter: return only rows for this fiscal year, e.g. "2024". This is the filer's OWN fiscal year label (NVDA's FY2024 ended Jan 2024), not a calendar year. Unmatched years are reported with the years that ARE available rather than as an empty result. | |
| fiscal_period | No | Optional filter: return only rows for this period within the fiscal year — "FY" (annual), "Q1", "Q2", "Q3", or "Q4" (derived: FY minus Q1-Q3). Combine with fiscal_year for a single figure. | |
| ticker_or_cik | No | Alias for `cik` — the spelling used by edgar_company_filings, edgar_insider_transactions and edgar_product_revenue. |
Output Schema
| Name | Required | Description |
|---|---|---|
| cik | Yes | Company CIK number |
| label | Yes | Human-readable concept label |
| concept | Yes | US-GAAP concept tag name |
| description | Yes | Detailed concept description |
| company_name | Yes | Official company name |
| annual_values | Yes | Annual values sorted by fiscal year descending |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnly/idempotent/openWorld safety. The description adds substantial beyond-annotation context: it discloses the Q4 derivation behavior (derived:true via FY minus Q1-Q3), that SEC filers never report standalone Q4, the newest-first ordering, and the `latest` field semantics. It doesn't discuss rate limits, but the derivation and return-shape disclosures are strong value-add.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the value proposition, but the description is long and dense, packing many overlapping points (aliases, derivation, latest semantics, examples) into a single dense paragraph. Most content earns its place, but it could be trimmed and structured more cleanly without losing meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only analysis tool with an output schema present, the description covers the key behavioral nuances an agent needs: aliasing, derivation of Q4, latest field, and period filtering. Return-format details are rightly left to the output schema. Complete enough to call correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all parameters thoroughly, including aliases and the fiscal_year/fiscal_period labels. The description reinforces the alias behavior (cik/ticker/ticker_or_cik, concept/metric) and explains the friendly-name vs exact-tag resolution, but the schema does the heavy lifting. Baseline 3 appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: retrieves authoritative historical financials from SEC XBRL filings for any US public company. It names the source, the metric resolution behavior, and clearly distinguishes itself from siblings like edgar_company_facts (raw tags) or edgar_xbrl_frames by focusing on friendly-named concepts for a single company.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit when-to-use guidance: 'Use for "what was AAPL's revenue in 2024"', 'NVDA's latest cash position', and it warns 'do not default to latest for a period question.' It distinguishes period-questions from point-in-time metrics and names when to use `latest` vs filtered values. This is unusually thorough routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_company_factsEdgar Company FactsARead-onlyIdempotentInspect
AUTHORITATIVE full XBRL fundamentals dump for a US public company. Send the company as cik — that argument takes a TICKER ("NVDA") or a CIK ("320193"), and ticker / ticker_or_cik are accepted as aliases for it. Returns every reported financial metric (hundreds of concepts: revenue, net income, assets, liabilities, EPS, cash flow lines, segment breakdowns) with annual and historical values pulled straight from the company's SEC filings — the official numbers, not estimates. Use when you need the complete fundamental picture vs. one metric (for one metric use edgar_company_concept). Leads with latest_annual — revenue, net income, assets, cash, EPS for the most recent fiscal year, resolved to whichever XBRL concept the filer currently reports under — and flags retired concepts (e.g. a pre-ASC-606 Revenues tag) as stale so a 2010 figure is never mistaken for current. Large payload; agents typically use this once to discover available concepts then narrow to edgar_company_concept for follow-up queries. For just the headline figures plus the recent filings list, edgar_company_snapshot is the smaller one-call answer.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | REQUIRED (or one of its aliases `ticker` / `ticker_or_cik`). Ticker ("NVDA") or CIK number ("320193"). Tickers are auto-resolved to CIKs internally. | |
| ticker | No | Alias for `cik` — same thing, a ticker or a CIK. The spelling edgar_fund_holdings and edgar_ticker_to_cik use. | |
| ticker_or_cik | No | Alias for `cik` — the spelling edgar_company_filings, edgar_insider_transactions and edgar_product_revenue use. |
Output Schema
| Name | Required | Description |
|---|---|---|
| cik | Yes | Company CIK number |
| year_note | No | How `year` is derived |
| company_name | Yes | Official company name |
| latest_annual | Yes | Canonical line items for the most recent fiscal year — revenue, net_income, operating_income, gross_profit, total_assets, total_liabilities, stockholders_equity, cash_and_equivalents, eps_basic, eps_diluted, shares_outstanding, research_and_development — each resolved to whichever concept the filer currently reports under; null when the filer reports no current value |
| key_financials | Yes | Per-concept detail. Current concepts first, retired (stale) concepts last — a stale concept is kept because a historical series still needs it, never silently dropped |
| stale_concepts | Yes | Concepts the filer has stopped reporting; present in key_financials flagged stale, never used in latest_annual |
| latest_period_end | No | Period end of that most recent annual report (YYYY-MM-DD) |
| available_concepts | Yes | Total number of US-GAAP financial concepts available for this company |
| latest_fiscal_year | No | Fiscal year of the filer's most recent annual report across every concept examined |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: it flags retired concepts as stale, notes the payload is large, and explains that latest_annual is resolved to whichever XBRL concept the filer currently reports under. This is meaningful behavioral disclosure that helps the agent anticipate output quirks.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but well-organized: it front-loads the core purpose, then covers parameter semantics, output characteristics, usage guidance, and sibling routing. Every sentence earns its place, though it is somewhat long. The structure is logical and the key differentiators are prominent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (hundreds of concepts, aliases, large payload, stale concept handling), the description is remarkably complete. It covers what the tool returns, how to call it, what the aliases are, when to use it vs. alternatives, and what to expect in terms of payload size and data quality. The output schema exists, so return values need not be detailed further. Nothing an agent needs to select and invoke this tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters. The description adds value by clarifying that `cik` is the primary argument, that tickers are auto-resolved to CIKs internally, and that `ticker`/`ticker_or_cik` are aliases. This goes beyond the schema's per-parameter descriptions by explaining the relationship between the three parameters and the resolution behavior.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns every reported financial metric'), a specific resource ('full XBRL fundamentals dump for a US public company'), and explicitly distinguishes itself from siblings (edgar_company_concept, edgar_company_snapshot). It clearly identifies the tool's scope and differentiates it from alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use guidance: 'Use when you need the complete fundamental picture vs. one metric (for one metric use edgar_company_concept)' and 'For just the headline figures plus the recent filings list, edgar_company_snapshot is the smaller one-call answer.' It also notes the typical usage pattern: 'agents typically use this once to discover available concepts then narrow to edgar_company_concept for follow-up queries.' This is explicit routing with alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_company_filingsEdgar Company FilingsARead-onlyIdempotentInspect
AUTHORITATIVE list of recent SEC filings for a specific US public company. Send the company as ticker_or_cik — that argument takes a ticker ("AAPL") or a CIK ("320193"), and cik / ticker are accepted as aliases for it. Filter by form type — "10-K" (annual report), "10-Q" (quarterly), "8-K" (material event — but for severity-classified 8-Ks specifically, prefer sec_8k_recent), "DEF 14A" (proxy), "S-1" (IPO registration), etc. Returns filing dates, form types, accession numbers, document links. Use for "what did $TICKER recently file" or "show me the last N proxy statements for $TICKER". For specific financial metrics over time use edgar_company_concept; for the full XBRL dump use edgar_company_facts. If you also need the headline financials alongside the filings, edgar_company_snapshot returns both in one call.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK. | |
| limit | No | Max filings to return (1-40, default 20) | |
| ticker | No | Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK. | |
| form_type | No | Filter by SEC form type (e.g., "10-K", "10-Q", "8-K"). Omit for all types. | |
| ticker_or_cik | No | REQUIRED (or one of its aliases `cik` / `ticker`). Ticker symbol (e.g., "AAPL") or CIK number (e.g., "320193") |
Output Schema
| Name | Required | Description |
|---|---|---|
| cik | Yes | Company CIK number |
| sic | No | SEC Standard Industrial Classification CODE, 4 digits (e.g. "2836" Biological Products, "3571" Electronic Computers). The machine-readable twin of sic_description - branch on this, not on the prose. |
| filings | Yes | |
| tickers | Yes | Associated ticker symbols |
| company_name | Yes | Official company name |
| fiscal_year_end | Yes | Fiscal year end date |
| sic_description | Yes | Standard Industrial Classification description |
| filter_form_type | Yes | Form type filter applied or 'all' |
| state_of_incorporation | Yes | State where company is incorporated |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish the tool as read-only, idempotent, and non-destructive, so the safety profile is covered. Beyond that, the description adds the authoritative/recent scope, alias flexibility, and the return fields (dates, form types, accession numbers, document links); it does not state ordering or pagination, but that is minor given the output schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but dense, and every sentence earns its place: purpose first, then identifier semantics, form-type filtering, return contents, use cases, and sibling routing. It is front-loaded and logically ordered with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only listing tool with a full output schema and annotations covering safety, the description covers identification, filtering, return shape, and when to use alternatives. Nothing an agent needs to invoke it correctly is left unclear.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: it explains that ticker_or_cik accepts either a ticker or CIK, that cik/ticker are aliases, and it labels form types ("10-K" annual report, "10-Q" quarterly, "DEF 14A" proxy, "S-1" IPO). This goes beyond the schema's terse field descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens by naming the exact deliverable: an "AUTHORITATIVE list of recent SEC filings for a specific US public company," with a concrete verb (list) and resource (SEC filings). It further distinguishes itself by naming edgar_company_concept, edgar_company_facts, and edgar_company_snapshot for different jobs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit conditions and examples: "Use for 'what did $TICKER recently file' or 'show me the last N proxy statements'" and routes financial metrics, full XBRL, and headline-financial-plus-filings to specific siblings. The only flaw is the reference to sec_8k_recent, which is not present in the available sibling list, making one routing instruction unactionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_company_snapshotEdgar Company SnapshotARead-onlyIdempotentInspect
ONE CALL for "give me the SEC picture on $TICKER" / "what has $COMPANY filed recently and what are its numbers" / "pull the filings and financials for X". Resolves a ticker, company name or CIK and returns, from SEC EDGAR, the three things callers otherwise chain by hand across edgar_ticker_to_cik -> edgar_company_filings -> edgar_company_concept: the identity (cik, company_name, tickers, SIC code, fiscal year end), the recent filings list (accession numbers, form types, filing dates, document links — by default the substantive forms 10-K/10-Q/8-K/20-F/40-F/6-K/DEF 14A, so insider Form 4 noise is excluded; pass form_type for one form or "all"), and the headline XBRL figures from the latest annual report (revenue, net income, operating income, gross profit, assets, liabilities, equity, cash, EPS, shares, R&D — each resolved to the concept the filer CURRENTLY reports under, with retired concepts listed separately as stale). Send the company as ticker_or_cik; cik / ticker are accepted aliases. A filer with no XBRL facts (a fund, a trust, a foreign private issuer on paper forms) still returns its filings, with financials_status: "unavailable" and a reason, not an error. Drill down from here: edgar_filing_text for a filing's text, edgar_company_concept for one metric's multi-year history, edgar_company_facts for every concept. For a cross-source view (patents, contracts, hiring, news) use entity_profile instead.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — same thing. The spelling edgar_company_facts and edgar_company_concept use. | |
| ticker | No | Alias for `ticker_or_cik` — same thing. The spelling edgar_ticker_to_cik uses. | |
| form_type | No | Which filings to list. Omit for the substantive default set (10-K, 10-K/A, 10-Q, 10-Q/A, 8-K, 20-F, 40-F, 6-K, DEF 14A). Pass one form ("10-K") to list only that form, or "all" for every form including Form 4 insider filings. | |
| filings_limit | No | How many filings to return after the form filter (1-40, default 10). | |
| ticker_or_cik | No | REQUIRED (or one of its aliases `cik` / `ticker`). Ticker ("AAPL"), company name ("Apple Inc") or CIK ("320193"). Tickers and names are resolved to a CIK internally. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnly/idempotent/non-destructive, and the description adds substantial behavioral context: ticker/name/CIK resolution, default substantive-form filtering, 'financials_status: unavailable' with a reason instead of an error, and stale-concept handling. It clearly discloses what the tool does and does not return beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but densely packed and front-loaded with the one-call value proposition. Every sentence earns its place: scope, defaults, alternatives, aliases, error behavior, and drill-downs are all covered without repetition or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and a complex multi-part return, the description compensates by enumerating the identity fields, filing list fields, and financial metrics, and by covering the no-XBRL edge case. It is complete enough for an agent to call the tool and interpret the result without needing to guess.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the description adds value beyond it: explaining that `ticker_or_cik` accepts ticker, name, or CIK; that `form_type` can be a single form or 'all'; and that financial metrics are resolved to the filer's current reporting concepts. Aliases are explicitly clarified as equivalent spellings used by sibling tools.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('returns') and names the exact resource ('SEC picture on $TICKER'), explicitly enumerating the three outputs: identity, filings list, and XBRL figures. It distinguishes itself from the chain of edgar_ticker_to_cik -> edgar_company_filings -> edgar_company_concept and from sibling tools, making selection unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use framing ('ONE CALL for...'), names the manual chain it replaces, and provides concrete routing guidance for drill-downs (edgar_filing_text, edgar_company_concept, edgar_company_facts) and the cross-source alternative (entity_profile). This is the strongest possible usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_filing_documentsEdgar Filing DocumentsARead-onlyIdempotentInspect
AUTHORITATIVE list of the SEC filing documents inside ONE specific filing, by accession number. Retrieve a filing / its contents / attachments: pass the accession (e.g. "0000320193-25-000079", with or without dashes) plus the filer's ticker ("AAPL") or CIK ("320193"). Returns every document in the filing folder — the primary document (10-K / 10-Q / 8-K body), all exhibits, and XBRL files — each with name, type, size, and a direct https URL, plus the filing's form type, filing date, and human -index.html page. Set include_primary_text:true to also pull the primary document's text (HTML stripped to plaintext, ~40k chars). Use to list a 10-K / 10-Q / 8-K's exhibits, retrieve filing contents/attachments, or fetch the text of a filing. You can pass an exact accession, OR just a ticker + form_type to auto-resolve the latest matching filing (no accession lookup needed). Examples: edgar_filing_documents({ticker: "NVDA", form_type: "10-K"}) for the documents in NVIDIA's latest annual report; edgar_filing_documents({accession: "0000320193-25-000079", ticker: "AAPL", include_primary_text: true}) for a specific filing's text.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | The filer's CIK number (e.g. "320193"). Provide this OR ticker. | |
| ticker | No | The filer's ticker (e.g. "AAPL", "NVDA") or company name. Provide this OR cik. Tickers are auto-resolved to CIKs. | |
| accession | No | Optional SEC accession number of a specific filing, with or without dashes (e.g. "0000320193-25-000079"). Omit it to auto-resolve the latest filing — pass form_type instead. | |
| form_type | No | When accession is omitted, the form type of the latest filing to fetch, e.g. "10-K", "10-Q", "8-K", "DEF 14A" — or a `|`-separated SET ("10-K|10-Q") for "the most recent of either, whichever is newer". Omit both accession and form_type to get the single most recent filing of ANY type at all (routine 8-Ks/Form 4s/Form 144s included, not just annual/quarterly reports) — use the `|` set instead when you specifically want the newest 10-K or 10-Q. | |
| ticker_or_cik | No | Alias for `ticker` / `cik` — the single-argument spelling edgar_company_filings and edgar_insider_transactions use. Takes either a ticker or a CIK. | |
| include_primary_text | No | When true, also fetch the primary document and return its text (HTML stripped to plaintext, truncated to ~40,000 chars). Default false. For the FULL, pageable document text — or just one section like going-concern/liquidity — use edgar_filing_text instead. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare a safe, idempotent, read-only, open-world read, so the safety burden is covered. The description adds genuine behavioral context beyond that: what the return contains (name/type/size/direct https URL plus form type, filing date, index page), the ~40k-char truncation of include_primary_text, and the fallback-to-latest-any-type behavior. Not exhaustive on error cases, but well above what annotations supply.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in the first sentence and every subsequent sentence carries usage or return information. It runs long and duplicates some of the schema's own examples, which is the only waste, but it stays readable and non-repetitive at the sentence level.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the return-value burden and does so fully: enumerates documents, their metadata, and the filing-level fields. Combined with the annotations and 100%-covered schema, an agent has everything needed to call this correctly across both invocation modes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3 and the schema already documents each field. The description still adds value by pairing parameters into real call shapes (accession+ticker, ticker+form_type), noting accession works with or without dashes, and clarifying the ticker/CIK OR and omitted-form_type semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource and scope: 'AUTHORITATIVE list of the SEC filing documents inside ONE specific filing, by accession number.' It explicitly distinguishes itself from the sibling it is not (edgar_filing_text for full pageable text, edgar_company_filings via the alias note), so an agent can separate it from siblings without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-to-use cases ('list a 10-K/10-Q/8-K's exhibits, retrieve filing contents/attachments, or fetch the text of a filing') and a clear alternative for full text ('use edgar_filing_text instead'). It also documents the auto-resolve path and even warns that omitting form_type returns routine 8-Ks/Form 4s, steering the agent to the `|` set when it wants a real report.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_filing_textEdgar Filing TextARead-onlyIdempotentInspect
AUTHORITATIVE full text of a SEC filing's primary document (10-K / 10-Q / 8-K body), HTML stripped to clean plaintext — the source for disclosures that live in prose, not XBRL: going-concern language, ATM / at-the-market equity facilities, committed-equity share caps, public-float figures, subsequent events, the liquidity footnote, and MD&A KPIs XBRL never tags (test volume, units shipped, subscriber counts, same-store sales). Pass an accession (from edgar_search_filings / edgar_company_filings) plus the filer's ticker or CIK; OR omit accession and pass ticker + form_type to auto-resolve the latest matching filing. For a specific fact inside a long filing, pass search (a word or exact phrase, e.g. "tests processed" or "processed approximately") instead of paging blind — it scans the WHOLE document (before any offset/max_chars windowing) and returns every matching passage with surrounding context and its own offset in the document, so a KPI ~100k characters in is found in one call instead of paging through max_chars windows by hand. A zero-match search is a real answer (the filing does not use that exact wording) — retry with a shorter or different phrase rather than assuming the tool failed. For a question asking two facts from the same filing ("revenue and test volume in the latest 10-Q"), pass search as |-separated phrases (e.g. "revenue|tests processed") to get both in this one call under searches[] — and when a phrase names a financial total (revenue, net income, EPS, ...), the matching XBRL figure for this exact accession comes back under xbrl even if that total never appears as an absolute number in the prose (common: filings often state only the growth delta/percentage in text). Optionally set section to return just one part (going_concern | liquidity | capital_resources | subsequent_events); search runs within that slice when both are given. Large docs (a 10-Q is ~100k+ chars of text) are PAGED, not spilled, when search is not used: the result caps at max_chars (default 50000) from offset, and returns truncated + next_offset — pass next_offset back as offset to read the next window. An especially large filing (e.g. an S-1 with heavy inline-XBRL tagging can exceed 10MB of raw HTML) is also capped on the READ side — the response sets raw_truncated:true when only the first portion of the document was read at all, which bounds how far offset can page (and how far search can scan) and can make a late section or search term come back not-found even though it exists further in. Use for "does $TICKER disclose substantial doubt / going concern", "what ATM facility does $TICKER have", "read the liquidity section of the latest 10-Q", "how many tests did $TICKER process this quarter". For the list of documents/exhibits in a filing use edgar_filing_documents; for structured financial numbers use edgar_company_concept.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Filer CIK number (e.g. "1652935"). Provide this OR ticker. | |
| find | No | Alias for `search`. | |
| offset | No | Character offset to start from (default 0). Pass the prior result's next_offset to page forward. | |
| phrase | No | Alias for `search`. | |
| search | No | Find a specific fact instead of paging blind. Pass a short 2-4 word phrase likely to appear VERBATIM in the prose ("processed approximately", "tests processed", "going concern") rather than restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice), run BEFORE max_chars/offset windowing; returns matching passages (context + their own offset) instead of the paged `text`, ranking passages with a nearby figure first. If a multi-word phrase has no verbatim match, it falls back to the phrase's individual words and returns the passages holding the most of them (search.match_mode "words") — read those passages for the fact rather than treating them as confirmed. Use a returned offset with a follow-up call (no `search`) to read more surrounding text. **For TWO OR MORE facts from this same filing in one call, separate phrases with `|`** (e.g. "Signatera revenue|tests processed") — each is searched independently and reported under `searches[]`, keyed by `phrase`, instead of the singular `search`. This is the way to answer a compound question ("what was revenue AND test volume in the latest 10-Q") without a second call. Note: a phrase naming a financial TOTAL (revenue, net income, EPS, assets, cash, gross/operating profit, long-term debt, stockholders equity, shares outstanding) often has NO verbatim match at all, because filers frequently state only the growth delta/percentage in prose and report the actual total exclusively in XBRL — when a phrase names one of these, the response also attaches that concept's value for THIS SAME accession under `xbrl` (sourced like edgar_company_concept, not text-matched), so you don't need a separate edgar_company_concept call just to get the number the text search alone would report as a false "not found". Accepted aliases: `contains`, `find`, `phrase`. | |
| ticker | No | Filer ticker (e.g. "ACTU"). Provide this OR cik. ONLY pass a ticker you are CERTAIN of — a wrong remembered ticker silently retrieves a DIFFERENT company's filing as a clean success (a "SpaceX" question filled with SPCE returns Virgin Galactic's S-1). For a recent IPO or any uncertain ticker, resolve first: edgar_company_filings accepts the company NAME and returns the cik — pass that cik here. | |
| section | No | Return only this section (located by heading). Omit for the whole document. Unmatched sections fall back to the whole document (section_found:false). | |
| contains | No | Alias for `search`. | |
| accession | No | SEC accession number, dashed or not (e.g. "0001683168-26-003909"). Omit to auto-resolve the latest filing of form_type for the given ticker/cik. | |
| form_type | No | When accession is omitted, the form type of the latest filing to fetch — "10-K", "10-Q", "8-K", "DEF 14A", etc. For "the most recent 10-K OR 10-Q" (or any "whichever of these is newer" question), pass a `|`-separated SET, e.g. "10-K|10-Q" — do NOT guess a single type ("10-K" by habit skips a newer 10-Q) and do NOT omit this field to get "any type", since a company files far more 8-Ks/Form 4s/Form 144s between annual or quarterly reports than it files the reports themselves and an empty form_type returns the single most recent filing of ANY kind (verified live 2026-09-25, fleet #2450: NTRA's single most recent SEC filing was a Form 144 insider-sale notice, filed weeks after its real 10-Q and completely unrelated to the question asked). | |
| max_chars | No | Max characters to return in this page (1000–100000, default 50000). Doc text past this is available via next_offset. | |
| ticker_or_cik | No | Alias for `ticker` / `cik` — the single-argument spelling edgar_company_filings and edgar_insider_transactions use. Takes either a ticker or a CIK. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/non-destructive, and the description still adds substantial non-obvious behavior: `search` runs over the WHOLE document before offset/max_chars windowing, zero-match is a legitimate answer, multi-word phrases fall back to word-matching (match_mode 'words'), passages are ranked with nearby figures first, a read-side `raw_truncated` cap bounds how far offset and search can reach, and financial-total phrases return an `xbrl` value for the same accession. That is a genuinely richer behavioral profile than the annotation set provides.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The opening sentence is front-loaded and the sectioning is logical, but the body is ~600 words of dense, bold-heavy, ALL-CAPS emphasis that duplicates the schema's `search` and `form_type` descriptions almost verbatim. The inline warning about NTRA's Form 144 (fleet #2450, dated verification) is presumably internal evaluation provenance leaking into a tool description and does not earn its space in agent-facing text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the full return-shape burden and does so: `text`, `truncated` + `next_offset` paging, `raw_truncated`, `searches[]` keyed by phrase, `xbrl`, `section_found`. It also explains the two resolution paths (accession, or ticker/cik + form_type auto-resolve) and the ticker-safety caveat. Nothing needed to call this correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the per-property docs are already thorough, so the baseline is 3. The description nevertheless adds cross-parameter workflow meaning the individual property docs do not: how `search` and `section` compose, why `form_type` should be a `|` set rather than omitted or guessed, and how `next_offset`/`offset` page a document. It largely restates the schema's `search` entry, which keeps it short of 5.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific verb+resource: 'AUTHORITATIVE full text of a SEC filing's primary document (10-K / 10-Q / 8-K body), HTML stripped to clean plaintext.' It explicitly carves out what it is NOT for versus siblings, naming edgar_filing_documents (exhibits) and edgar_company_concept (structured numbers). An agent can pick this over those two without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives named alternatives and the conditions that select them: use edgar_filing_documents for the document/exhibit list, edgar_company_concept for structured financials, and this tool for prose disclosures. It further routes within the tool itself — pass `search` instead of paging blind, pass `section` for one part, pass `|`-separated phrases for compound questions — with concrete example queries ('does $TICKER disclose substantial doubt', 'how many tests did $TICKER process').
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_fund_holdingsEdgar Fund HoldingsARead-onlyIdempotentInspect
AUTHORITATIVE portfolio holdings of a US ETF or mutual fund (SEC Form N-PORT) — what the fund actually owns. Pass the FUND's ticker (e.g. "ARKK", "QQQ", "VTI", "VOO", "IVV"). Returns the latest monthly portfolio: net assets, holdings count, and top positions by weight — each with name, CUSIP, value (USD), and % of fund. Use for "what does ARKK hold", "top holdings of QQQ", "is $STOCK in VTI". Distinct from edgar_institutional_holdings (13F = what an investment MANAGER like Berkshire owns); this is a registered fund's own N-PORT. Covers US-registered open-end funds + ETFs; data is ~30-60 days delayed. Note: a few legacy ETFs structured as unit investment trusts (e.g. SPY, DIA) don't file N-PORT and won't resolve — use IVV or VOO for S&P 500 exposure.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Top N holdings by weight to return (1-100, default 25) | |
| ticker | No | REQUIRED (or its alias `ticker_or_cik`). ETF or mutual-fund ticker (e.g. "ARKK", "SPY", "QQQ"). Fund tickers, not company stock tickers. | |
| ticker_or_cik | No | Alias for `ticker` — the spelling sibling SEC tools (edgar_company_filings, edgar_insider_transactions) use. Must still be a FUND ticker: N-PORT funds are keyed by ticker, so a bare CIK will not resolve here. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds significant behavioral context: data is ~30-60 days delayed, only US-registered funds covered, and funds like UITs are excluded. It doesn't contradict annotations—readOnly is consistent with a read-only query. The description goes beyond annotations to set expectations about data freshness and coverage limitations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than typical but every sentence serves a purpose: purpose, usage, examples, distinction, coverage, and exclusions. The essential info (what it does, how to use) is front-loaded, with edge cases at the end. It's not overly verbose given the complexity (fund vs manager distinction). It loses a point for being a bit longer than ideal, but it's well-organized and each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 3 parameters and no output schema, the description is nearly complete. It explains the output will include net assets, holdings count, and top positions with name, CUSIP, value, and % of fund. It also covers common failure modes (non-US funds, UITs, CIK misuse) and provides alternatives. It doesn't specify pagination or error details, but those are less critical. Given the tool's moderate complexity, this is near-complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% since both parameters have descriptions, providing a baseline of 3. The description adds value by clarifying the ticker parameter is REQUIRED (despite schema showing required: []), and warns that `ticker_or_cik` is an alias but must be a fund ticker, not a CIK. It also explains that 'limit' is a preference (1-100, default 25) implicitly. This elevates from baseline to a 4 because it clears up the ambiguity around the alias and the required nature of ticker.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a clear verb ('Pass'), resource (US ETF/mutual fund portfolio holdings from SEC Form N-PORT), and specific scope (latest monthly portfolio with net assets, holdings count, top positions). It explicitly differentiates from edgar_institutional_holdings by naming the sibling and defining what it covers (13F managers vs. fund's own N-PORT). The phrase 'AUTHORITATIVE' adds confidence, and the list of example queries makes the purpose unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit usage instructions: pass the fund's ticker (not company tickers), provides example tickers, mentions the alias `ticker_or_cik` and warns that a CIK won't resolve. It explicitly contrasts with edgar_institutional_holdings and explains the N-PORT vs 13F distinction. It also provides negative guidance: funds structured as UITs (SPY, DIA) won't work, with a suggested alternative (IVV, VOO) for S&P 500 exposure. This is exactly what the dimension asks for.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_insider_transactionsEdgar Insider TransactionsARead-onlyIdempotentInspect
AUTHORITATIVE insider trading activity (SEC Form 3/4/5) for a US public company — who bought or sold, how many shares, at what price, and what they hold now. Send the company as ticker_or_cik — a ticker ("TSLA") or a CIK — and cik / ticker are accepted as aliases for it. Returns each recent Form 4 filing parsed into structured transactions: reporting owner + role (director/officer/10% holder), transaction code (P=open-market purchase, S=sale, A=grant/award, M=option exercise, G=gift, F=tax-withholding), shares, price per share, acquired/disposed, and shares owned after. Use for "insider buying at $TICKER", "did executives sell recently", "latest Form 4 activity". Open-market purchases (code P) are the strongest conviction signal; awards (code A) are routine comp. For the raw filing list use edgar_company_filings with form_type:"4".
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK. | |
| limit | No | Max Form 4/3/5 filings to parse (1-25, default 10) | |
| ticker | No | Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK. | |
| ticker_or_cik | No | REQUIRED (or one of its aliases `cik` / `ticker`). Ticker symbol (e.g., "TSLA") or CIK number (e.g., "1318605") | |
| include_derivatives | No | Also include derivative (options/RSU) transactions. Default false (non-derivative common-stock only). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as read-only, idempotent, and non-destructive. The description adds meaningful behavioral context by decoding transaction codes (P, S, A, M, G, F), explaining that P is the strongest conviction signal and A is routine compensation, and describing the parsed output structure. This goes well beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence contributes: purpose, input identification, output structure, example use cases, signal interpretation, and alternative routing. The most important information is front-loadedaisd the 'AUTHORITATIVE' opener and the transaction-code explanations are compact and high-signal.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the burden of explaining return values, and it does so thoroughly: reporting owner, role, transaction code, shares, price, acquired/disposed, and post-transaction holdings. It also covers input alternativeschers, use cases, and the sibling for raw filings, making it complete for an agent to select and invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds useful context about aliases and requiredness, but this is largely redundant with the schema. It does not materially deepen understanding of parameter semantics beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly identifies the tool as returning parsed SEC Form 3/4/5 insider transaction activity for a US public company, specifying who traded, direction, price, and resulting holdings. It distinguishes itself from raw-filing tools by emphasizing 'parsed into structured transactions' and by implying it is the authoritative source for this specific data.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly provides example queries ('insider buying at $TICKER', 'did executives sell recently') and points to the alternative tool for raw filing lists: 'For the raw filing list use edgar_company_filings with form_type:"4".' This gives an agent clear when-to-use and when-to-use-other guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_institutional_holdingsEdgar Institutional HoldingsARead-onlyIdempotentInspect
AUTHORITATIVE stock portfolio of a large institutional investor (SEC Form 13F-HR) — what a fund/manager owns, share counts, and position values. Pass the MANAGER's ticker or CIK (e.g. "BRK-B" or CIK "1067983" for Berkshire Hathaway; "1350694" for Bridgewater). Returns the latest quarterly 13F: top holdings aggregated by issuer with value (USD), shares, and % of portfolio, plus the report period. Use for "what does Berkshire own", "Bridgewater's biggest positions", "which funds hold $TICKER" (run per manager). Note: 13F covers US-listed long equity + options held by managers with >$100M AUM, filed ~45 days after quarter-end; it excludes shorts, cash, and non-US holdings. Values are whole USD for filings since 2023; older ones are in thousands. IMPORTANT: rows carry a put_call field and a plain-English direction. A put row is a BEARISH bet AGAINST that issuer — never report it as a holding the manager owns — and for option rows the value is the underlying's notional, not premium or capital at risk. Rank real holdings by pct_of_long_equity, and read position_summary + interpretation_note before summarising.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK. | |
| limit | No | Top N holdings by value to return (1-100, default 25) | |
| ticker | No | Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK. | |
| ticker_or_cik | No | REQUIRED (or one of its aliases `cik` / `ticker`). The institutional manager's ticker (e.g. "BRK-B") or CIK (e.g. "1067983"). NOT the held stock — the fund/manager doing the filing. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds substantial behavioral context beyond that: the put_call/direction warning (never report a put as a holding), the notional-vs-premium caveat for options, the whole-USD vs thousands change for pre-2023 filings, and the instruction to rank by pct_of_long_equity and read position_summary/interpretation_note. This is exactly the kind of non-obvious behavior an agent needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but every sentence earns its place: scope, examples, use cases, caveats, and ranking instructions. It is front-loaded with the core purpose and the manager-vs-stock distinction. It is longer than average, but the complexity of 13F data justifies the length; the put_call warning alone prevents a serious reporting error.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only lookup tool with no output schema, the description covers everything an agent needs to call it correctly and interpret results: input format, examples, scope limitations, value units, option semantics, and ranking guidance. The only minor gap is that it doesn't describe the exact JSON shape of the response, but the description's mention of fields (value, shares, pct_of_long_equity, position_summary, interpretation_note) compensates.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all four parameters. The description adds value by clarifying that ticker_or_cik (and its aliases) refers to the manager, not the held stock, and by giving concrete CIK examples. It also explains the meaning of the returned value field (whole USD vs thousands), which is not in the schema. It doesn't add much about `limit`, but the schema already covers that.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a precise statement: it returns the authoritative 13F-HR portfolio of an institutional manager, with share counts, position values, and report period. It explicitly distinguishes the manager (the filer) from the held stock, and gives concrete examples (BRK-B, Bridgewater CIK). This clearly differentiates it from siblings like edgar_fund_holdings and edgar_company_facts.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use examples ('what does Berkshire own', 'Bridgewater's biggest positions', 'which funds hold $TICKER') and states the key input requirement: pass the MANAGER's ticker or CIK, not the held stock. It also notes the run-per-manager behavior and the 13F scope (US-listed long equity, >$100M AUM, ~45-day lag), which helps an agent decide when this tool is appropriate versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_product_revenueEdgar Product RevenueARead-onlyIdempotentInspect
PRODUCT-LEVEL or segment-level revenue as STRUCTURED data — e.g. "how much revenue did Keytruda generate", "AAPL revenue by product line". Regular XBRL tools (edgar_company_concept, edgar_company_facts) only expose UNDIMENSIONED totals; a filer's product/segment breakdown is tagged with an XBRL dimension (e.g. a "Keytruda [Member]"), which those APIs cannot see no matter which concept is requested. This tool reads SEC's own standardized "Financial Report" rendering of that dimensional data straight out of the annual or quarterly segment-reporting / revenue-disaggregation note — 10-K and 10-Q for US filers, 20-F for foreign private issuers (Novartis, AstraZeneca, GSK, Sanofi, Novo Nordisk, Takeda) and 40-F for Canadian MJDS filers, resolved automatically and reported back as resolved_form — the same note human analysts read, but pre-parsed into rows. Pass product_filter (case-insensitive substring, matched against the dimension breadcrumb, e.g. "Keytruda") to get just one product/segment instead of the whole table. Every result carries a citation (accession, filing date, exact report + URL it came from). Not every filer discloses product-level revenue in XBRL, and a small fraction use a non-standard table layout this parser can't read — both are reported as an explicit status rather than a silent empty array, with a fallback to edgar_filing_text for the prose note.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK. | |
| limit | No | Max rows to return (1-200, default 100). | |
| ticker | No | Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK. | |
| accession | No | Optional exact accession number (from edgar_company_filings) to read a specific past filing instead of the latest matching form_type. | |
| form_type | No | Filing type to read the note from. Omit it to try 10-K, then 20-F, then 40-F automatically — foreign private issuers (NVS, AZN, GSK, SNY, NVO, TAK) file 20-F and Canadian MJDS filers file 40-F. "10-Q" also works for filers that disaggregate revenue quarterly. The form actually used comes back as `resolved_form`. | |
| ticker_or_cik | No | REQUIRED (or one of its aliases `cik` / `ticker`). Ticker (e.g. "MRK") or CIK (e.g. "310158"). Tickers are auto-resolved. | |
| product_filter | No | Optional case-insensitive substring to match against the product/segment dimension, e.g. "Keytruda". Omit to get every disaggregated row in the table. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: it discloses that not every filer discloses product-level revenue in XBRL, that a small fraction use a non-standard table layout the parser can't read, and that both cases are reported as an explicit status rather than a silent empty array. It also explains the automatic form resolution and the resolved_form output field. This is strong behavioral transparency, though it doesn't detail rate limits or exact error statuses.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but well-organized, front-loading the core purpose and differentiation before diving into parameters and edge cases. Every sentence earns its place: the first sentence states the purpose, the second differentiates from siblings, the third explains the data source, the fourth covers filtering, the fifth covers citations, and the sixth covers failure modes. It's longer than ideal but the length is justified by the tool's complexity and the need to distinguish it from closely related siblings.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 7 parameters, no output schema, and significant complexity around XBRL dimensions and form types, the description is remarkably complete. It covers what the tool returns (structured rows with citations), how to filter, which form types are supported, how resolution works, what the resolved_form field means, and what happens in failure cases. The only minor gap is not describing the exact output row structure, but the description's mention of 'pre-parsed into rows' and 'citation (accession, filing date, exact report + URL)' provides sufficient context for an agent to understand the return shape.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all 7 parameters thoroughly. The description adds value by explaining the semantics of product_filter (case-insensitive substring matched against the dimension breadcrumb), the form_type fallback order, and the alias relationships between ticker_or_cik, cik, and ticker. It also clarifies that ticker_or_cik is effectively required despite the schema listing 0 required parameters. This goes beyond the schema's individual field descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'PRODUCT-LEVEL or segment-level revenue as STRUCTURED data' and immediately gives concrete example queries ('how much revenue did Keytruda generate', 'AAPL revenue by product line'). It explicitly distinguishes itself from sibling tools edgar_company_concept and edgar_company_facts by explaining that those tools only expose undimensioned totals while this one reads dimensional XBRL data. This is a clear, specific purpose that an agent can act on.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool vs alternatives: 'Regular XBRL tools (edgar_company_concept, edgar_company_facts) only expose UNDIMENSIONED totals... which those APIs cannot see no matter which concept is requested.' It also names the fallback tool (edgar_filing_text) for cases where the parser can't read the table. It explains form-type resolution (10-K, 20-F, 40-F, 10-Q) and the product_filter behavior. This is exemplary usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_search_filingsEdgar Search FilingsARead-onlyIdempotentInspect
PREFER OVER WEB SEARCH for "what did $COMPANY say about X in their SEC filings" or "find filings that mention Y". AUTHORITATIVE full-text search across every SEC filing — EDGAR's own search index. Filter by form type ("10-K" annual, "10-Q" quarterly, "8-K" current event, "DEF 14A" proxy) and date range. Returns entity name, CIK, form type, filing/period dates, location, accession number (feed straight into edgar_filing_text / edgar_filing_documents — no second lookup), and — for 8-K results — the items array of item codes (e.g. "3.01" listing deficiency vs "1.01" material agreement vs "3.02" unregistered sale), which carry the actual signal. Use when you need to find filings matching a topic across the whole market, not for a specific company (for that use edgar_company_filings).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of results to return (1-40, default 10) | |
| query | Yes | Search query (e.g., "artificial intelligence", "Tesla revenue") | |
| end_date | No | End date in YYYY-MM-DD format (e.g., "2024-12-31") | |
| form_type | No | Filter by SEC form type (e.g., "10-K", "10-Q", "8-K", "DEF 14A"). Omit for all types. | |
| start_date | No | Start date in YYYY-MM-DD format (e.g., "2024-01-01") |
Output Schema
| Name | Required | Description |
|---|---|---|
| query | No | The search query used |
| results | No | |
| date_range | No | |
| total_hits | No | Total number of matching filings |
| form_type_filter | No | Form type filter applied or 'all' |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so safety is covered. The description adds valuable behavioral context: it returns specific fields (entity, CIK, dates, accession number), explains the significance of the 8-K 'items' array, and notes that results can be fed directly into edgar_filing_text/documents without a second lookup. It does not mention rate limits or pagination, but with the safety profile already annotated, the added context goes beyond the minimum.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but well-organized, front-loading the most important guidance ('PREFER OVER WEB SEARCH') and authoritativeness. It packs substantial detail (return fields, 8-K items, downstream chaining) into a compact paragraph without fluff. Slightly longer than necessary but every sentence earns its place given the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (5 params, output schema, many siblings), the description is highly complete: it explains the tool's scope, return value highlights, how to chain with related tools, the 8-K item codes' signal value, and explicitly contrasts with the company-specific alternative. The output schema covers return structure, so the description doesn't need to restate it. No significant gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with each parameter already described (query, limit, form_type, start_date, end_date). The description adds minor clarifications like mapping form types to annual/quarterly/current event and notes the date range, but this mostly repeats schema information. The accessory number 'feed straight into' detail relates to return values, not parameter semantics, so the description adds little beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('search') and resource ('SEC filings' via EDGAR's full-text index), clearly stating it is the authoritative tool for finding filings that mention a topic. It distinguishes itself from the sibling edgar_company_filings by noting it searches across the whole market rather than for a specific company.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says 'PREFER OVER WEB SEARCH' for certain query types and gives an exclusion: 'not for a specific company (for that use edgar_company_filings)'. This provides clear when-to-use and when-not-to-use guidance, including a named alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_ticker_to_cikEdgar Ticker To CikARead-onlyIdempotentInspect
Resolve a US stock ticker (e.g. "TSLA") OR a company name (e.g. "Tesla", "Apple Inc") to the SEC's 10-digit CIK identifier — required by every other SEC tool. Call THIS FIRST when you have a ticker/name and need to use edgar_company_concept, edgar_company_filings, edgar_company_facts, sec_8k_recent, or any other SEC-keyed tool. Returns {cik, cik_padded, company_name, ticker, matched_by}; when matched by name it also returns alternatives for disambiguation. Cheap, no rate limit concerns. Most other tools also accept tickers/names directly and call this internally — only use it explicitly when you want the CIK as data. The response carries a next hint: the usual NEXT step after resolving is edgar_company_snapshot({ticker_or_cik}), which returns the recent filings list AND the headline XBRL financials in one call — do not chain edgar_company_filings then edgar_company_concept by hand to get that.
| Name | Required | Description | Default |
|---|---|---|---|
| ticker | No | REQUIRED (or one of its aliases `ticker_or_cik` / `company`). Stock ticker symbol (e.g., "AAPL", "MSFT", "TSLA") or company name (e.g., "Apple", "Microsoft") | |
| company | No | Alias for `ticker` — use it when what you have is a company NAME ("Apple Inc.") rather than a symbol. Same argument, same behaviour. | |
| ticker_or_cik | No | Alias for `ticker` — the spelling edgar_company_filings and edgar_insider_transactions use. A ticker or company name; this tool RESOLVES to a CIK, so passing a bare CIK has nothing to look up. |
Output Schema
| Name | Required | Description |
|---|---|---|
| cik | Yes | Company CIK number |
| ticker | Yes | Stock ticker symbol; null for a filer not on SEC's current-listed list (delisted, bankrupt, never listed) resolved by name via matched_by "edgar_entity_search" |
| cik_padded | Yes | CIK padded to 10 digits with leading zeros |
| company_name | Yes | Official company name |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as read-only, idempotent, and non-destructive, so the bar is lower, but the description adds meaningful behavioral detail beyond annotations: cheap to call with no rate limit concerns, returns a structured result including `alternatives` for name matches, and carries a `next` hint pointing to edgar_company_snapshot. No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than average, but each part earns its place: purpose, call-order guidance, return shape, explicit-use caveat, and follow-up hint. It is front-loaded with the primary purpose and the call-first instruction, then layers in progressively finer details without repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's moderate complexity, the rich annotations, and the presence of an output schema, the description is complete enough for correct invocation. It covers aliases, when to avoid explicit use, cost/rate-limit characteristics, return shape, and even the recommended next step, leaving no practical gap for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3, but the description adds value by explaining alias semantics (`ticker`, `company`, `ticker_or_cik`), giving concrete examples (AAPL, TSLA), and clarifying the edge case that passing a bare CIK has nothing to look up because this tool resolves to a CIK.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb and resource: 'Resolve a US stock ticker OR a company name to the SEC's 10-digit CIK identifier'. It also names the downstream SEC tools that depend on this resolution, distinguishing this tool from siblings like edgar_company_filings and edgar_company_concept.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance ('Call THIS FIRST when you have a ticker/name and need to use ...') and equally explicit when-not-to-use guidance ('only use it explicitly when you want the CIK as data'). It also notes that most other tools accept tickers/names directly and call this internally, which prevents unnecessary chaining.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edgar_xbrl_framesEdgar Xbrl FramesARead-onlyIdempotentInspect
Compare ONE financial metric across ALL public companies for a single period (SEC XBRL "frames"). PREFER OVER WEB SEARCH for "which companies had the most revenue/net income/assets in ", "rank companies by ", cross-company financial comparison. concept is a US-GAAP tag (e.g. "Revenues", "NetIncomeLoss", "Assets", "ResearchAndDevelopmentExpense", "CashAndCashEquivalentsAtCarryingValue"). period is a calendar frame: "CY2023" (annual), "CY2023Q1" (quarter), or "CY2023Q1I" (instant/balance-sheet, period-end). Returns companies + values, sorted descending by default. Differs from edgar_company_concept (one company over time) — this is one period across every filer.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | "desc" (default, largest first) or "asc". | |
| unit | No | Unit of measure (default "USD"). Use "shares" for share counts, "USD-per-shares" for per-share. | |
| limit | No | Max companies to return (1-200, default 25). | |
| period | Yes | Calendar frame: "CY2023" (annual duration), "CY2023Q1" (quarterly duration), or "CY2023Q1I" (instant, balance-sheet items at period end). | |
| concept | Yes | US-GAAP (or dei) tag, e.g. "Revenues", "NetIncomeLoss", "Assets", "ResearchAndDevelopmentExpense". | |
| taxonomy | No | Taxonomy: "us-gaap" (default) or "dei". |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnly, openWorld, idempotent, and non-destructive. Description adds details: returns sorted descending, concept is a US-GAAP tag, period formats explained, and behavior across every filer.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with clear sections and examples, but slightly verbose. Every sentence adds value, though a minor reduction could improve conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 6 parameters and no output schema, the description fully covers usage, parameters, return behavior (sorted descending, limit 200), and examples. No gaps for an AI agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Despite 100% schema coverage, description provides rich context for concept (examples), period (CY2023 vs Q1 vs I), and unit (shares, USD-per-shares), enhancing understanding beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool compares one financial metric across all public companies for a single period, distinguishing it from sibling tool edgar_company_concept (one company over time).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly recommends this tool over web search for cross-company financial comparisons and ranking, and contrasts with edgar_company_concept for when to use each.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
entity_profileEntity ProfileARead-onlyIdempotentInspect
"Tell me about X" / "research Acme" / "brief me on Tesla" / "what does Apple do" / "company profile for Microsoft" / "give me the rundown on NVDA" / "everything you know about $TICKER" — full cross-source profile of a US public company in ONE parallel call. ALWAYS PREFER over chaining single-pack SEC/XBRL/news lookups when the user asks for a holistic view. Fans out across SEC EDGAR, XBRL, USPTO patents, federal contracts (USAspending), FDA-licensed biologics (Purple Book), H-1B hiring (DOL LCA), news and GLEIF, and returns: cik + company_name (+ resolved_from/resolved_to when value was a name); recent_filings (up to 5 with pipeworx://edgar/company/{cik}/filings/{accession} URIs); fundamentals (the latest ANNUAL Revenues, NetIncomeLoss, Cash, diluted EPS, capex and operating cash flow, each with its period_end, SEC form and the accession of the filing it came from — plus EntityCommonStockSharesOutstanding, which is the newest COVER-PAGE share count the filer has published rather than an annual one, so its period_end is a cover date after the quarter closed and it is the right per-share denominator; a filer tagging a fallback concept appears under the name of that tag instead, e.g. PaymentsToAcquireProductiveAssets instead of PaymentsToAcquirePropertyPlantAndEquipment); patents (USPTO PatentsView API sunset May 2025 — soft-fails until reactivated); federal_contracts (USAspending awards where the company is the recipient); fda_products (FDA-licensed biologics — vaccines, cell/gene therapies — from the Purple Book; a company with only small-molecule/generic drugs will show none here, that is expected, not a failure); hiring (H-1B sponsorship volume + salary range from DOL LCA filings); recent news mentions via GDELT→GNews fallback; LEI via GLEIF. sources_used / sources_failed say which of these actually returned data for THIS company — an empty section is a real "no data", not a bug. sources_skipped is the third state: a leg we deliberately did NOT run, each entry carrying a reason token and a plain-English detail (the Purple Book is skipped for a filer SEC classifies outside the life-science SIC bands, since it lists only 351(a)/(k) biologics licence holders). Pass a ticker ("AAPL"), zero-padded CIK ("0000320193"), OR a company name ("Moderna") — names now resolve via SEC EDGAR's company-name match; a private company (no CIK/ticker) returns resolved:false with an explicit notes line, not a bare failure. type accepts "company" or "ticker" interchangeably — both take the same value shapes above.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | "company" or "ticker" — both are accepted and behave identically; `value` can be a ticker, CIK, or company name either way. person/place coming soon. | |
| value | Yes | Ticker (e.g., "AAPL"), zero-padded CIK (e.g., "0000320193"), or company name (e.g., "Moderna"). A NAME now resolves through the national business registers as well as SEC EDGAR, so a non-US company returns its register identity and record rather than `resolved: false`. | |
| country | No | OPTIONAL ISO 3166-1 alpha-2 of the business register you mean ("NO", "FI", "GB", "JP", "FR", "EE", "BR"). Only affects a NAME lookup, and is often what separates the company you mean from a US namesake. When a name resolves to a register entity with no CIK, the SEC/CIK-keyed sections are reported under `sources_skipped` with reason `not_queried` — they were never asked, which is not the same as having failed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations cover the safety profile (readOnly/idempotent/openWorld/non-destructive), and the description adds substantial context beyond them: the three-state sources_used/sources_failed/sources_skipped model, the meaning of an empty section, the PatentsView soft-fail, and the deliberate Purple-Book skip. This is exactly the operational detail an agent needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The useful use-case examples are front-loaded, but the body is a single enormous sentence with deeply nested parentheticals (the diluted-EPS cover-page aside, the fallback-tag aside, the Purple-Book aside). The density of genuinely relevant detail does not excuse the wall-of-text structure that makes it hard to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and a highly complex multi-source fan-out, the description carries the burden well: it enumerates every returned section, the per-source state tokens, and the name-resolution behaviour. An agent knows what to expect back and how to interpret partial results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents type/value/country, and the description largely restates that (type interchangeability, accepted value shapes). It adds some real meaning — country 'only affects a NAME lookup' and the resolved:false path for private companies — but not enough to exceed the baseline when the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource — a 'full cross-source profile of a US public company in ONE parallel call' — and enumerates the exact data legs (SEC EDGAR, XBRL, USPTO, USAspending, etc.). It clearly distinguishes itself from siblings like company_facts, deep_research and resolve_entity by covering the holistic-view use case.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit selection rule: 'ALWAYS PREFER over chaining single-pack SEC/XBRL/news lookups when the user asks for a holistic view,' with concrete trigger phrasing ("Tell me about X", "research Acme"). The alternative and the condition that selects it are both stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
filer_to_sponsorsFiler To SponsorsARead-onlyIdempotentInspect
The REVERSE of sponsor_to_filer: given a US-listed public FILER (parent company), list its operating subsidiaries as disclosed in Exhibit 21 of its most recent 10-K (Item 601(b)(21) — "significant subsidiaries"). Built for the same trial-sponsor/entity-resolution join, run the other direction: instead of ~10 calls guessing candidate subsidiary names and confirming each via sponsor_to_filer, get the parent's full disclosed subsidiary list (with jurisdiction of incorporation) in one call, straight from SEC — e.g. Merck (MRK/CIK 310158) -> "Merck Sharp & Dohme LLC" among hundreds of others. Pass name_filter (case-insensitive substring) to check whether a specific candidate name is among the subsidiaries without reading the whole list. Every result carries provenance (accession number, filing date, exhibit URL) so the join is auditable. Smaller filers or ones with no significant subsidiaries can genuinely have no Exhibit 21 — status distinguishes that from a lookup failure. Foreign private issuers (20-F filers) are not yet covered.
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK. | |
| limit | No | Max subsidiaries to return (1-500, default 200). Large parents can disclose 500+. | |
| ticker | No | Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK. | |
| name_filter | No | Optional case-insensitive substring to filter subsidiary names by, e.g. "Sharp & Dohme" to check whether that entity is among the parent's disclosed subsidiaries. Subsidiary names in Exhibit 21 use "&", not "and". | |
| ticker_or_cik | No | REQUIRED (or one of its aliases `cik` / `ticker`). The PARENT company's ticker (e.g. "MRK") or CIK (e.g. "310158"). Tickers are auto-resolved to CIKs. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish readOnly/idempotent/non-destructive behavior, and the description adds substantial beyond-annotation context: results carry provenance (accession number, filing date, exhibit URL), the status distinguishes 'no Exhibit 21' from lookup failure, data comes straight from SEC, and subsidiary names use '&' not 'and.' No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a dense single paragraph, but it is front-loaded with the core function and reverse relationship, then moves through the use case, a concrete example, filter behavior, provenance, and limitations. It is longer than minimal, but each sentence carries useful information and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex SEC-lookup tool with no output schema, the description covers what the caller receives, how to audit results via provenance, how to filter, and a known coverage gap (Foreign private issuers). An agent has enough context to select the tool and interpret unusual outcomes like a missing Exhibit 21.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already documents aliases, the limit range, and name_filter's case-insensitive substring behavior. The description reinforces the aliases and the use of name_filter, but adds little parameter meaning beyond what the schema already provides, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource: given a US-listed public filer/parent company, list its operating subsidiaries disclosed in Exhibit 21 of the most recent 10-K. It also explicitly frames itself as the reverse of sponsor_to_filer, clearly distinguishing it from the closest sibling tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly contrasts this tool with sponsor_to_filer, explaining that this is the one-call direction for getting a parent's full subsidiary list, versus '~10 calls guessing candidate subsidiary names and confirming each via sponsor_to_filer.' It also gives the specific name_filter use case for checking a candidate entity, and notes the Foreign private issuer exclusion.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
forgetForgetADestructiveIdempotentInspect
Delete a previously stored memory by key. Use when context is stale, the task is done, or you want to clear sensitive data the agent saved earlier. Pair with remember and recall.
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | Alias for key. | |
| key | Yes | Memory key to delete. Accepts name, k, label as aliases. | |
| name | No | Alias for key. | |
| label | No | Alias for key. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=true, and readOnlyHint=false, so the safety and write profile are covered. The description aligns with those hints but adds little behavioral context beyond the use cases; it does not, for example, state whether deleting a missing key is an error or what the response looks like. With annotations carrying the main burden, a 3 is appropriate and there is no contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler: the core action and key-based scoping come first, followed directly by usage guidance and sibling pairing. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple deletion tool with a fully documented schema, explicit destructive/idempotent annotations, and no output schema obligations, the description covers what an agent needs: what it deletes, when to use it, and how it relates to remember and recall. Nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already explains that key, k, name, and label are aliases for the memory key. The description adds no parameter-level details, but since the schema fully documents the single meaningful parameter, it does not need to; baseline 3 is correct.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb-resource pair: 'Delete a previously stored memory by key.' It clearly distinguishes the tool from its siblings remember and recall by naming them and positioning forget as the deletion counterpart, so an agent can select it correctly without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit triggering conditions: 'Use when context is stale, the task is done, or you want to clear sensitive data the agent saved earlier.' It also names the complementary tools remember and recall, routing the agent to its siblings and making the when-to-use decision unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_llms_txtGenerate llms.txtARead-onlyIdempotentInspect
Generate a production-ready llms.txt file for any URL so AI crawlers (ChatGPT, Claude, Perplexity) can index the site cleanly. Fetches the page, extracts title/description/key links, and emits the standard llms.txt markdown format. Output is a single text blob ready to drop at site-root/llms.txt. Useful for: getting a client's site indexed by AI, drafting llms.txt for your own project, or auditing how an AI crawler would see a competitor.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Full URL of the site to summarize, e.g. "https://example.com" or a specific landing page. | |
| max_links | No | Maximum number of link entries to include (default 25, max 50). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description adds valuable behavioral context by explaining that it fetches the page, extracts title/description/key links, and emits standard llms.txt markdown. It does not cover failure modes or rate limits, but the annotation coverage lowers the bar for this dimension.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences: purpose, process, and use cases. It is front-loaded with the core action, contains no fluff, and every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a two-parameter tool with no output schema, the description is sufficient: it specifies the output format ('single text blob ready to drop at site-root/llms.txt'), the process, and the use cases. Minor gaps like error handling are not critical given the tool's simplicity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents both url and max_links. The description does not add parameter-specific semantics beyond what the schema provides, which is acceptable; the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Generate') and resource ('llms.txt file for any URL'), and explains the process (fetch, extract, emit). It does not explicitly contrast with siblings like ai_visibility_check, but the purpose is unambiguous and clearly distinct from the other tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides concrete use cases ('getting a client's site indexed by AI, drafting llms.txt for your own project, or auditing how an AI crawler would see a competitor'), giving clear context for when to use it. It does not mention when to prefer a sibling or any exclusions, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
kalshi_weather_edgeKalshi Weather EdgeARead-onlyIdempotentInspect
Prices Kalshi daily high-temperature markets against the NWS forecast for the market's OWN settlement station, and measures whether that forecast actually beats the market. Two modes. LIVE (default): returns the full strike ladder for one city and settlement date with market_prob (mid), forecast_prob, and edge_pp per strike, plus the settlement clause verbatim. BACKTEST (backtest_days: N): scores an archived gridded forecast against the market on settled days and returns brier_market vs brier_forecast with a plain-English verdict, so the edge is MEASURED rather than asserted. READ THE WARNINGS — they are not boilerplate. (1) These markets DO NOT settle on the NWS. They settle on The Weather Company (weather.com) at a Kalshi station code such as CLINYC, which the response quotes verbatim; so part of every edge_pp is NWS-vs-Weather-Company disagreement about the same day at the same station, which is not mispricing and not tradeable. settlement_vs_forecast_basis_f from backtest mode is that part as a number. (2) The station is DERIVED from the settlement clause, never from the city name: Chicago settles at MIDWAY and New York at CENTRAL PARK, so a city-centre forecast would misprice a whole ladder. A station that cannot be resolved yields rows with no forecast and a reason, never a guessed coordinate. (3) forecast_prob assumes a normal distribution around the NWS high whose width is ASSUMED, not fitted (stated in distribution_assumption) — run backtest mode to see whether it is calibrated. (4) edge_pp is gross: no Kalshi fees, no bid-ask. MEASURED RESULT, AND IT IS NOT THE FLATTERING ONE: on the first backtest (KXHIGHNY, 13 settled days to 2026-09-11, 58 market observations) the MARKET beat the forecast — Brier 0.1008 for the market against 0.1594 for the archived gridded forecast, lower being better. So on that sample there is NO forecast edge to sell, and a large edge_pp is more likely to be the model disagreeing with a better-informed market than an opportunity. The measured settlement-vs-forecast basis was 1.7F mean absolute over 8 pinnable days, slightly warm-biased, which is a big share of a typical edge_pp on a 2-degree bracket. Re-run backtest_days before believing any edge; if a later sample reverses this, the numbers say so. NWS is US-only, so the ~30 international Kalshi weather series (London, Paris, Tokyo) return market prices with forecast_unavailable rather than a forecast. Precipitation series are listed but not yet priced. Cities: nyc, chicago, los angeles, miami, austin, houston, denver, philadelphia — or pass series_ticker for any other (e.g. "KXHIGHTBOS").
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City to price, e.g. "nyc", "chicago", "los angeles", "miami", "austin", "houston", "denver", "philadelphia". Defaults to nyc. Unmapped cities return known_cities[] rather than a wrong series. | |
| date | No | Settlement date as YYYY-MM-DD. Defaults to the soonest open event. Daily weather markets open ~1-2 days ahead and close 05:00Z the next day. | |
| market_type | No | "high_temp" (default) | "precip". Precipitation markets return prices but no forecast_prob yet. | |
| backtest_days | No | Run measurement mode over the last N settled days (max 60) instead of pricing today. Returns brier_market vs brier_forecast, the settlement-vs-forecast basis, and per-day detail. Both sides are scored at 12:00Z on each event day — before the daily high and before resolution — because a settled market prices the known outcome at close. | |
| series_ticker | No | Explicit Kalshi series, e.g. "KXHIGHNY" or "KXHIGHTBOS" (Boston). Overrides `city`; use it for any of the 121 daily weather series not in the city list. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes far beyond the annotations by disclosing non-obvious behavioral traits: markets settle on Weather Company, not NWS; station is derived from settlement clause; forecast_prob uses an assumed normal distribution; edge_pp is gross; and it exposes a concrete measured result showing the market beat the forecast. These are exactly the kind of caveats an agent needs to interpret results correctly, and they are not visible in the read-only/open-world annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but tightly packed with critical trading caveats. It is front-loaded with purpose and modes, then structured warnings (1-4), then a measured result, followed by edge-case handling. While not concise, the density is justified given the financial stakes and the need to prevent misuse; it could be slightly more scannable with headers, but overall each sentence carries weight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description must specify return values, and it does: LIVE mode returns the strike ladder with market_prob, forecast_prob, edge_pp, and the settlement clause; BACKTEST returns brier_market vs brier_forecast, settlement-vs-forecast basis, and a plain-English verdict. It also covers international and precipitation fallbacks, and the warning section covers all major edge cases. Nothing an agent needs to call the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds substantial meaning to each parameter: 'city' includes a default and fallback behavior (unmapped cities return known_cities[]), 'date' explains open/close timing, 'market_type' clarifies precipitation returns no forecast, 'backtest_days' explains the scoring methodology and max, and 'series_ticker' overrides city. This is a textbook example of enriching schema with operational context.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: 'Prices Kalshi daily high-temperature markets against the NWS forecast...' and explicitly defines two modes (LIVE and BACKTEST) with distinct outputs. It differentiates itself from sibling tools by focusing on a niche weather-edge analysis, and the many specific details (station codes, edge_pp, brier scores) leave no doubt about its purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use guidance: 'LIVE (default)' vs 'BACKTEST (`backtest_days: N`)', and tells the user to run backtest before believing any edge. It also covers exclusions: international series return forecast_unavailable, precipitation is not priced, and it warns about using city-centre forecasts when stations are derived from settlement clauses. This is model-guidance beyond what any sibling alternative offers.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_subscriptionsList SubscriptionsARead-onlyIdempotentInspect
List the caller's active subscriptions. Returns id, type, params, created_at, last_fired_at, fire_count for each. Use this to review what you're monitoring before adding more or to find an id to cancel.
| Name | Required | Description | Default |
|---|---|---|---|
| include_inactive | No | Include cancelled subscriptions in the response (default false). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, openWorld, idempotent, and non-destructive behavior. The description adds meaningful behavioral detail by scoping to the caller's active subscriptions and enumerating the returned fields, which goes beyond what annotations provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences carry all the essential information: what the tool lists, what it returns, and when to use it. The primary action is front-loaded and there is no redundant wording.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only list tool with one optional documented parameter and no output schema, the description is complete: it names the resource scope, the returned fields, and the use cases. Nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the single optional include_inactive parameter is already fully documented. The description does not add further parameter context, which matches the baseline of 3 for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource: 'List the caller's active subscriptions.' It also lists the exact return fields, making the operation concrete and clearly distinct from sibling tools like subscribe and unsubscribe.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool: 'review what you're monitoring before adding more' and 'find an id to cancel.' It gives clear context, though it does not explicitly name sibling alternatives or state when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
pipeworx_feedbackSend Pipeworx FeedbackAInspect
Tell the Pipeworx team something is broken, missing, or needs to exist. Use when a tool returns wrong/stale data (bug), when a tool you wish existed isn't in the catalog (feature/data_gap), or when something worked surprisingly well (praise). ONLY for tools served by this Pipeworx connection — if the tool came from a different MCP server in your client (another vendor's Gmail, Splunk, Slack, etc. connector), we cannot fix it and reporting it here only delays you; file it with that server instead. Not sure? Pipeworx tool names are the ones this connection lists. Describe the issue in terms of Pipeworx tools/packs — don't paste the end-user's prompt. Filing without an account returns a claim_token; pass it back later as pipeworx_feedback({claim_token:"pwfb_…"}) to read whether it was fixed and what changed. The team reads digests daily and signal directly affects roadmap. Rate-limited to 5 per identifier per day. Free; doesn't count against your tool-call quota.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | bug = something broke or returned wrong data. feature = a new tool or capability you wish existed. data_gap = data Pipeworx does not currently expose. praise = positive note. other = anything else. | |
| context | No | Optional structured context: which tool, pack, or vertical this relates to. | |
| message | No | Your feedback in plain text. Be specific (which tool, what error, what data was missing). 1-2 sentences typical, 2000 chars max. | |
| claim_token | No | Read the reply to a report you filed earlier: pass the `pwfb_…` token that filing returned, with no other arguments. Returns the status and, once resolved, what actually changed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes far beyond the annotations: discloses the claim_token return-and-lookup flow, rate limit (5/day/identifier), cost (free, no quota), and operational facts (team reads digests daily, signal affects roadmap). Also instructs on content policy (describe in terms of Pipeworx tools, don't paste user prompts). No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
Dense but every sentence earns its place: purpose is front-loaded, the critical exclusion comes early, then workflow, then operational constraints. The length is justified by the tool's nuance (claim tokens, rate limits, server-scoping) and there is zero filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite no output schema, the description fully covers what an agent needs: when to call, what to include, what to expect (claim_token), how to follow up later, and operational limits. No important behavioral aspect is left unexplained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all parameters at 100%, giving baseline 3. The description adds real value beyond schema by explaining the claim_token round-trip workflow and the message content rule (mention specific tool/pack, avoid pasting user prompts). These clarify how to use the parameters correctly, lifting the score above baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description opens with a clear verb+resource: 'Tell the Pipeworx team something is broken, missing, or needs to exist.' It names the three content categories (bug, feature/data_gap, praise) and explicitly excludes tools from other MCP servers, so an agent can immediately distinguish this from any sibling or external tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-to-use conditions (wrong/stale data, missing catalog entry, positive experience) and an explicit when-not-to-use with an alternative action: file with the other server instead. Also provides a disambiguation heuristic ('Pipeworx tool names are the ones this connection lists'). This is exemplary routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
pipeworx_trendingPipeworx TrendingARead-onlyIdempotentInspect
What other AI agents are calling on Pipeworx right now. Returns the top tools, top packs, and total call volume over a recent window (24h, 7d, or 30d). Useful for: (1) discovering what data sources are hot for current events, (2) confirming a popular tool is the canonical choice before asking your own question, (3) seeing whether your use case aligns with what most agents need. Self-aggregating signal — derived from CF analytics-engine, no PII, just (pack, tool, count). Cached 5min-1h depending on window.
| Name | Required | Description | Default |
|---|---|---|---|
| window | No | 24h (default) | 7d | 30d. Shorter windows surface what's hot right now; longer windows show steady-state demand. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnly/openWorld/idempotent annotations, the description discloses that the data is self-aggregating, derived from CF analytics-engine, contains no PII, and only exposes (pack, tool, count). It also states caching behavior (5min-1h depending on window), which is useful operational context not present in the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core result set, then uses a compact numbered list for use cases. Every remaining sentence adds substantive value — data source, privacy, and caching — with no filler or repetition beyond the minor window mention.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read-only tool, the description fully covers what the agent needs: what it returns, what windows are available, how the data is derived, and that it is privacy-safe. The absence of an output schema is adequately compensated by naming the return components (top tools, top packs, total call volume).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage for the single optional window parameter is 100%, including the enum values and an explanatory description that already notes the default and the hot-vs-steady-state tradeoff. The description reiterates the window options but does not add meaning beyond what the schema already provides, so the baseline score of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a clear purpose — what other AI agents are calling on Pipeworx right now — and specifies the exact deliverables: top tools, top packs, and total call volume over a window. This is a specific resource plus a concrete return set, making it easy to distinguish from sibling tools like discover_tools or recent_alerts.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides three explicit use cases: discovering hot data sources, confirming a canonical tool, and aligning with aggregate agent behavior. It does not explicitly say when not to use it or name an alternative, but the 'Useful for' list gives clear contextual guidance for choosing this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
polymarket_arbitragePolymarket ArbitrageARead-onlyIdempotentInspect
Find arbitrage opportunities on Polymarket via monotonicity violations + partition-sum checks. Call with NO args for a trending_scan of the top 200 markets by weekly volume; pass event for the strongest per-event partition_check, or topic for a themed cross-event scan. event (recommended for a specific market): pass a Polymarket event slug like "fed-decision-may-2026" or "when-will-bitcoin-hit-150k"; walks child markets, checks date-axis / threshold-axis ordering AND computes the partition_check (sum of YES prices across mutually-exclusive legs — should ≈1; deviations >3pp emit a BUY/SELL EVERY LEG signal). topic (for cross-event scanning): pass a seed question like "Strait of Hormuz traffic returns to normal" or "Fed rate decision"; searches related events across the platform, flattens markets, runs the comparator on the union. Cross-event mode catches "...by May 31" vs "...by Jun 30" patterns that single-event misses. SEMANTIC ANCHOR: cross-event pairs require ≥0.30 Jaccard similarity on question tokens (prevents Powell-Fed-Pause being paired with Powell-DOJ-probe); skipped_low_similarity surfaces the rejected pair count. PARTITION FILTER: drops will-person-X / will-manager-Y / will-someone-else- placeholder slugs; partitions with >20% placeholder fraction return null arb signal. Response: opportunities[] (gap_pp, suggested_trade, reasoning, monotonicity violation context), and in event mode partition_check{sum_yes_prices, gap_from_1, placeholders_filtered, suggested_trade}. FEES: every opportunities[] row and partition_check.arbitrage carry edge_pp_gross (== gap_pp / overround_pp), fees_pp, edge_pp_net, net_positive, plus polymarket_fee_pp, fee_basis and fee_categories[]. BOTH cost components are modeled: Polymarket's own per-category TAKER FEE (fee = shares × rate × p × (1-p), rates crypto 0.07 / sports-economics-culture-weather-other 0.05 / finance-politics-mentions-tech 0.04, geopolitics and world events fee-free; verified against Polymarket's own docs as of 2026-09-13) and Polygon gas ($0.02/leg). The taker fee dominates: ~$1.75 per 100 shares on a crypto market at 50c versus $0.02 of gas, so rows that looked profitable before fleet #1927 may now show net_positive:false — that is the correction, not a regression. Each leg is priced at ITS OWN market's rate and price (the fee curve peaks at 50c and falls toward both extremes). fee_basis says where the rate came from: 'payload' (read off the market, the normal case), 'category' (mapped from its fee category), 'fee_free', or 'fallback' (rate unknown — charged at the modal 0.05 rather than assumed free, so an unreadable market is never reported as costless). Where fill_check reprices against live depth, this does NOT double-count that spread cost. FILL CHECK: when the partition signal fires, arbitrage.fill_check prices it against live CLOB depth (theoretical_edge_pp_at_book vs realizable_edge_pp at 1000 shares/leg, thin_legs[]) — realizable_edge_pp ≤ 0 means the overround exists only at last-trade, not in the book; do not trade it. For custom sizing use polymarket_fill_risk.
| Name | Required | Description | Default |
|---|---|---|---|
| event | No | Single-event mode (use this if you know the specific Polymarket event): event slug like "fed-decision-may-2026" or "when-will-bitcoin-hit-150k". Full Polymarket URLs also accepted. | |
| topic | No | Cross-event mode (use this if you want to scan related events across the platform): a topic or seed question like "Fed rate decision" or "Strait of Hormuz traffic returns to normal". Tool searches Polymarket for related events and checks monotonicity across them. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark readOnly/idempotent/non-destructive, and the description goes far beyond them: fee calculation assumptions, category-specific taker fee rates, gas modeling, fee_basis provenance, fallback behavior, fill_check repricing against live depth, and the warning that net_positive:false is a correction rather than a regression. This is unusually transparent about edge cases and limitations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but densely packed and sectioned with clear labels (SEMANTIC ANCHOR, PARTITION FILTER, FEES, FILL CHECK) that make the content scannable. Every sentence contributes decision-relevant information, and the most important usage guidance is front-loaded before deeper fee and fill details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex analytic tool with no output schema, this description is remarkably complete: it covers all invocation modes, return fields (opportunities[], partition_check, fee fields), fee modeling, filtering behavior, fill-check semantics, and constraints. An agent has enough information to call the tool correctly and interpret its results without external lookups.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Although schema coverage is 100%, the description adds substantial meaning beyond the schema: event accepts Polymarket slugs or full URLs, topic expects a seed question, and the no-arg case is documented even though it is not a schema parameter. It also explains what each mode does with its input and what signal it produces.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Find arbitrage opportunities on Polymarket via monotonicity violations + partition-sum checks.' It further distinguishes three invocation modes (no-arg trending_scan, event, topic) and names polymarket_fill_risk as the custom-sizing alternative, so an agent can unambiguously tell this tool apart from its siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage conditions are explicit: no args for trending scan, event 'recommended for a specific market', topic for cross-event scanning. It also explains why cross-event mode catches patterns single-event misses and redirects to polymarket_fill_risk for custom sizing, leaving no ambiguity about when to choose each path.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
polymarket_edgesPolymarket EdgesARead-onlyIdempotentInspect
Scan top Polymarket markets and return opportunities where Pipeworx data disagrees with market price. Built for "what should I bet on today" — agents discover opportunities without paging hundreds of markets. FIVE MODEL FAMILIES grouped into three response segments under by_segment: (1) MODEL_DRIVEN — crypto_price (lognormal barrier from 90d FRED log-returns) and news_momentum (GDELT 7d/21d article-volume ratio, soft signal w/ halved Kelly). (2) STRUCTURAL_ARBITRAGE — partition_overround on mutually-exclusive events; per-leg favorite-longshot bias correction with per-sport α (tennis 1.02, soccer 1.10, MMA 1.15, default 1.0); placeholder-slug filter drops will-person-X / will-team-Y / will-manager-Z / will-someone-else- backstops; partitions with >20% placeholder fraction skipped entirely. (3) CONCENTRATED_LONGSHOT — basket trade when one leg ≥75% AND ≥2 longshots ≤8% AND portfolio return ≥25:1; rare-by-design (gates relaxed Run 8 from prior 85%/5%/50:1). EVERY OPPORTUNITY carries edge_pp_net (net of slippage AND Polymarket's own taker fee — fees_pp_applied itemises the fee component; see fees.ts for the published per-category schedule), kelly_fraction + kelly_fraction_half (capped at 0.25), market.liquidity, market.spread_pp, market.volume, plus a 24h-move warning ("Market moved X.Xpp in 24h") when the recent move alone exceeds the edge — your edge may already be in the price. TRADEABLE-EDGE KNOBS: min_liquidity / max_spread_pp drop opportunities where edge isn't realizable; min_partition_leg_kelly filters partitions by best per-leg Kelly. RESPONSE TOP-LEVEL: by_segment{model_driven,structural_arbitrage,concentrated_longshot}, fed_candidates/fed_note (Fed bets surface here, excluded from ranking — 1m-T vs EFFR signal is unreliable at meeting-month horizons without paid OIS/SOFR-futures data), and _diagnostics{concentrated_longshot:{...funnel counters},category_counts,filter_skips} so callers can see WHY a segment is empty (top-N stale, all candidates failed gates, knob dropped them). Cached 1h at the KV level keyed on all knobs.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Top N edges to return after ranking. Default 10, max 25. | |
| window | No | Polymarket volume window to filter markets. Default 1wk. | |
| min_kelly | No | Minimum half-Kelly fraction (as decimal, e.g. 0.005 = 0.5% of bankroll) to include single-leg opportunities. Default 0 (no filter). Skips opportunities that are too small to bet sensibly even if the edge is large. | |
| min_edge_pp | No | Minimum |edge| in percentage points to include (default 0.5). Edge is evaluated NET of slippage and Polymarket's own taker fee. | |
| slippage_pp | No | Assumed execution slippage in percentage points per leg (default 0.3), for bid/ask + thin depth cost that a last-trade price does not show. Subtracted from raw |edge| before ranking and Kelly sizing, ON TOP OF Polymarket's own taker fee — which is NOT zero (rate 0.04-0.07 depending on category, read off each market's own published fee schedule; see fees_pp_applied on every row and fees.ts for the full schedule). Bump slippage for very thin partitions; drop to 0 if you have a smarter fill model — the fee still applies regardless. | |
| max_spread_pp | No | Tradeable-edge filter. Maximum bid/ask spread in percentage points on the representative market. Default null (no filter). Set to 2 to require tight books — anything wider eats most plausible edges. | |
| min_liquidity | No | Tradeable-edge filter. Minimum $ liquidity on the representative market (or for partition_overround, on at least one top_leg). Default 0 (no filter). Set to 5000 to drop thin-book opportunities where executing the edge would walk the book past breakeven. | |
| category_filter | No | Comma-separated list to restrict the output: "model_driven" (crypto_price + news_momentum), "structural_arbitrage" (partition_overround), "concentrated_longshot". Combine like "model_driven,structural_arbitrage". Default: all. | |
| min_partition_leg_kelly | No | Minimum BEST per-leg half-Kelly fraction across a partition_overround opportunity's top_legs (or longshot_basket legs). Default 0 (no filter). Partition arbs always return kelly_fraction_half=0 at the parent level by design (basket trades don't compose to single-leg Kelly), so min_kelly never filters them — this knob applies to the per-leg Kelly inside top_legs instead. Use to suppress thin partitions whose individual leg edges aren't worth the per-leg slippage cost. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. The description adds a wealth of behavioral context beyond that: it explains caching at the KV level (1h, keyed on all knobs), the response segmentation into by_segment with diagnostics, the fee handling (net of slippage and taker fee, with fees_pp_applied itemized), and the 'rare-by-design' concentration longshot gate. It even explains the logic behind excluding fed bets. This is far more than annotations provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, extremely dense paragraph with heavy use of all-caps, abbreviations, and parentheticals (e.g., FIVE MODEL FAMILIES, edge_pp_net, fees.ts). While every sentence carries information, the structure is not appropriately sized for a tool description; it buries key facts like caching and diagnostics in a wall of text. It could be formatted with headings and bullet points for easier scanning. Although the content is valuable, it violates conciseness by requiring significant effort to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (9 parameters, no output schema, multiple model families) and that annotations only cover safety, the description is remarkably complete. It explains the three response segments, diagnostics, fed_candidates, the net-of-fee edge calculation, the role of each knob, and the caching behavior. An agent can understand what the tool returns and how to invoke it correctly without needing additional context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Though schema_description_coverage is 100%, the description adds significant semantic depth. For example, it explains that min_partition_leg_kelly applies to per-leg Kelly within top_legs and that partition arbs return kelly_fraction_half=0 at parent level by design—details not in the schema. It also clarified the interaction between slippage_pp and the Polymarket taker fee, and the purpose of tradeable-edge knobs. This goes well beyond the schema's own descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Scan top Polymarket markets and return opportunities where Pipeworx data disagrees with market price.' It clearly distinguishes itself from sibling tools like polymarket_arbitrage and polymarket_edge_tracker by focusing on discovery from Pipeworx data vs. market pricing. It also states its intended use case ('what should I bet on today'), making it unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for when to use the tool—for betting opportunity discovery—and even explains why Fed bets are excluded from ranking due to unreliable data. However, it does not explicitly name alternatives or say 'use this instead of X when...', so it lacks explicit exclusions. The 'Built for' phrasing implies usage but does not cover when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
polymarket_edge_trackerPolymarket Edge TrackerARead-onlyIdempotentInspect
Edge persistence and decay telemetry built from daily polymarket_edges snapshots. Answers "how long has this edge existed and is it shrinking?" — a fresh wide edge and a 3-week-old wide edge are different trades (the latter is wide for a reason nobody is willing to take). Args: days (lookback, default 14, max 30), window (snapshot family, default "1wk"). RESPONSE: tracked[] = every opportunity in the LATEST snapshot with its full edge_pp_net time-series across prior snapshots, first_seen, trend (new | widening | stable | decaying) and decay_pp_per_day (both computed on |edge_pp_net| — the value itself is signed by trade direction, negative = SELL YES); expired[] = opportunities that appeared in earlier snapshots but are GONE from the latest (closed, resolved, or arbed away) with their lifespan_days — the median lifespan is your competition clock; snapshot_dates[] = which days actually have data (snapshots are written when polymarket_edges runs on a cache-miss, so gaps mean nobody scanned that day). LIMITS: history depth is bounded by the 60-day snapshot TTL and starts from when snapshotting was enabled; decay numbers come from daily closes of edge_pp_net (net of default slippage AND Polymarket's own taker fee — see polymarket_edges), not intraday.
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Lookback in days (default 14, clamp 2-30). | |
| window | No | Which polymarket_edges window family to read snapshots for: 24hr | 1wk | 1mo (default 1wk). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as read-only, idempotent, and non-destructive, and the description adds substantial behavioral detail beyond that: snapshot gap semantics, TTL limits, fee-inclusive decay computation, the signed nature of edge_pp_net, expired[] lifecycle meaning, and the fact that decay uses daily closes rather than intraday data. 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but densely organized into Args, RESPONSE, and LIMITS sections, with the core purpose front-loaded. Some rhetorical flourishes ('the median lifespan is your competition clock') add color but not operational necessity. It earns a high score for structure, though it sacrifices some conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description fully carries the burden of explaining return values and edge cases. It explains tracked[], expired[], snapshot_dates[], data gaps, history depth limits, and fee/slippage treatment. An agent has everything needed to call this correctly and interpret the response.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both days and window fully. The description restates defaults and adds a 'max 30' note for days and the snapshot-family concept for window, but it does not introduce meaning beyond the schema's parameter descriptions. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific purpose: edge persistence and decay telemetry from daily polymarket_edges snapshots, and answers a concrete question ('how long has this edge existed and is it shrinking?'). It distinguishes itself from sibling tools like polymarket_edges by focusing on historical persistence/decay rather than current edge values.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly establishes when to use the tool: when an agent needs edge longevity, trend, and decay rather than just current edge values. It even explains why this matters ('a fresh wide edge and a 3-week-old wide edge are different trades'). However, it never explicitly names alternatives or states when not to use it, so it falls just short of full explicit routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
polymarket_fill_riskPolymarket Fill RiskARead-onlyIdempotentInspect
Realizable-vs-theoretical edge check against live CLOB order-book depth. REQUIRES one of market (single-market mode) or event (basket/partition mode). SINGLE-MARKET: pass a market slug/URL + side (buy_yes|sell_yes|buy_no|sell_no, default buy_yes) + size_usd (default 1000 — max spend on buys, target proceeds on sells); walks the ladder and returns top_of_book, vwap_fill_price, slippage_pp, shares_filled, max_fillable_usd, and a verdict (clean|degraded|cannot_fill). BASKET: pass an event slug/URL + side (sell_yes = capture overround by selling every leg, buy_yes = capture underround; default auto from partition sum) + size_usd interpreted as settlement notional S (shares per leg; each share pays $1); returns theoretical_sum vs realizable_sum (top-of-book vs VWAP across all legs), capture_ratio, profit_usd at executed size, per-leg fill detail, thin_legs[], max_clean_notional_usd, and forced_directional_risk naming the legs most likely to strand you unhedged. USE THIS before acting on any polymarket_arbitrage SELL/BUY-EVERY-LEG signal or any polymarket_edges trade above ~$500 — theoretical overround on thin books is not capturable, and partial basket fills convert an arb into an unhedged directional position (the dominant loss mode in real arb-bot P&L). FEES ARE NOT MODELLED HERE: vwap_fill_price/profit_usd are GROSS of Polymarket's own taker fee (rate 0.04-0.07 by category — see polymarket_edges/fees.ts), on top of which this tool prices depth-crossing cost; a thin-margin fill that looks clean here can still be net-negative after the fee.
| Name | Required | Description | Default |
|---|---|---|---|
| side | No | Single-market: buy_yes | sell_yes | buy_no | sell_no (default buy_yes). Basket: sell_yes | buy_yes (default auto — sell if partition sum > 1, buy if < 1). | |
| event | No | Basket mode: event slug or full polymarket.com URL — checks every leg of the partition. | |
| market | No | Single-market mode: market slug or full polymarket.com URL. | |
| size_usd | No | Single-market: USD to spend (buys) or target proceeds (sells). Basket: settlement notional — shares per leg, each paying $1 at resolution. Default 1000, clamp 10–1,000,000. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (readOnly, openWorld, idempotent, non-destructive), the description discloses operational behavior: it walks the order book, returns specific fields (top_of_book, vwap_fill_price, slippage_pp, etc.), models depth-crossing cost, and explicitly states fees are NOT modelled (gross vs net). It also warns about forced_directional_risk and thin books, adding substantial behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but well-structured, with clear sections (SINGLE-MARKET, BASKET, fees note) and no redundant filler. It is front-loaded with the core purpose and then provides mode-specific details. While it could be trimmed slightly, the length is justified by the tool's complexity and the need to convey both modes and caveats.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description must cover return values, which it does thoroughly (listing all fields for both modes). It also explains the fee implication and when the tool is applicable, making it complete for an agent to call correctly without needing to inspect schemas or other sources.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers all 4 parameters, but the description adds meaning beyond that: it explains the difference between single-market and basket interpretation of size_usd (max spend vs settlement notional), the auto-selection for side in basket mode, and the format of market/event (slug or URL). This enriches the schema's bare descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource ('Realizable-vs-theoretical edge check against live CLOB order-book depth') and clearly distinguishes between single-market and basket modes. It explicitly references sibling tools (polymarket_arbitrage, polymarket_edges) and tells the agent when to use this tool over them, making purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides explicit when-to-use guidance ('USE THIS before acting on any polymarket_arbitrage SELL/BUY-EVERY-LEG signal or any polymarket_edges trade above ~$500') and explains the rationale (theoretical overround not capturable, partial fills create unhedged positions). It also explains how to choose between single-market and basket modes based on input types.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
polymarket_kalshi_spreadPolymarket–Kalshi SpreadARead-onlyIdempotentInspect
Cross-venue spread between Kalshi and Polymarket for the same resolving question. The two venues sometimes price the same outcome 2-25pp apart because their participant pools differ — when the bet shapes are equivalent that delta is a real signal, when they aren't the tool says so. TWO MODES: (1) topic — 11 pre-mapped macro subjects ("fed", "btc", "eth", "cpi", "gdp", "sp500", "recession", "next_pope", "next_uk_pm", "next_israel_pm", "2028_president") auto-fetch the matching event on each venue. You do NOT have to use those exact keys: the topic is resolved through aliases and keywords, so "bitcoin", "fed rate decision", "inflation", "s&p 500" and "next pope" all land on the right subject, and resolution.topic_matched_by tells you whether it was an exact key, a known alias, a phrase found inside a longer question, or a single-keyword guess — treat "phrase" and "token" as a GUESS at what you meant. An unresolvable topic returns error:"mapping_failed" with mapping_stage:"topic_unrecognized" and known_topics[]; it never silently falls back to a default subject. (2) explicit kalshi_event_ticker + polymarket_event_slug for custom pairings — BOTH modes run the identical token-overlap matcher, so the same disclosures apply to both. resolution is returned in BOTH modes and says how each side's identifier was picked (which Kalshi series was queried, how many events came back, whether the chosen one had quoted markets; which Polymarket search query ran and why that event won). Fleet #2064: when two Polymarket candidates tie on resolution time polymarket_selected_by now SAYS so, names every tied slug, names the tie-break that actually decided it (the candidate whose metric_type matches the Kalshi series, else lexicographic slug order), and states whether the winner's metric matches the Kalshi series — it used to assert "picked the soonest-resolving" byte-identically on calls that returned DIFFERENT events, because the tie was settled by upstream fetch arrival order. RESPONSE: each venue's leg-by-leg prices (raw probability 0-1) plus matched spread[].top_spreads_pp (Kalshi − Polymarket) where the same outcome shows up on both sides. SAFETY FIELDS: compatibility_warning is a sentence and compatibility_codes[] the machine-readable form; BOTH can be non-empty on returned pairs, so read them even when matched_pairs>0. Codes: event_subject_mismatch (the two event titles share no subject words — probably not the same question), temporal_mismatch (the two events are about different SUBJECT months — e.g. Kalshi "CPI in October" vs Polymarket "September Inflation"), temporal_alignment_unknown (the subject month could not be parsed on one or both sides — NOT the same as confirmed-aligned; check each event yourself), non_equivalent_bet_shapes, no_candidate_pairs, unclassified_legs_excluded, pairing_unverified (set in EITHER mode whenever pairs are returned: the legs were matched by keyword and word overlap, not a shared resolution source). Each entry in top_spreads_pp carries its own flags[] (temporal_mismatch, temporal_alignment_unknown, event_subject_mismatch, low_token_overlap). A leg whose metric_type or match_subtype is "unknown" is NEVER paired — those comparisons land in spread.skipped_unclassified and, when the wording lined up, in spread.low_confidence_pairs[] for inspection only. temporal_alignment{polymarket_month,kalshi_month,aligned} tells you whether the two events are about the same SUBJECT calendar period, in EITHER mode — this is the period the question is ABOUT (e.g. "September" for a CPI release that settles in October), not necessarily when either side settles; null means it could not be computed (see temporal_alignment_unknown), not that the two sides align. Fleet #2062: this used to compare Polymarket's settlement date against Kalshi's subject month and call a match — fixed to compare subject month to subject month on both sides. FEES: every top_spreads_pp and low_confidence_pairs[] row carries edge_pp_gross (== |spread_pp|), fees_pp, edge_pp_net, net_positive, and BOTH venues' taker fees itemised as kalshi_fee_pp and polymarket_fee_pp (plus polymarket_fee_rate, polymarket_fee_category, polymarket_fee_basis). Kalshi leg: fee = ceil(0.07 * contracts * P * (1-P) * 100) / 100 dollars per order, verified against kalshi.com/docs and corroborating explainers as of 2026-09-12. Polymarket leg: fee = shares × rate × p × (1-p) with rate by category (crypto 0.07, sports/economics/culture/weather/other 0.05, finance/politics/mentions/tech 0.04, geopolitics and world events fee-free), verified against Polymarket's own docs as of 2026-09-13 and read off each market's published fee parameters rather than inferred. Both amortized at a 100-contract reference size. Before fleet #1927 the Polymarket leg carried modeled gas only, which made every edge_pp_net here optimistic by up to ~1.75pp; spreads that no longer clear are the correction. Spread-crossing cost is still NOT modeled on the Polymarket leg (no live order book is fetched by this tool). spread.fees_note carries the same disclosure. RESOLUTION EQUIVALENCE (fleet #1909): every top_spreads_pp and low_confidence_pairs[] row now also carries resolution_equivalent ("true"|"false"|"unclear") and, when not "true", resolution_warning naming what differs — computed ONCE per event pair (not per leg) via resolution_audit/resolution_diff off one representative leg from each side, since the settlement mechanism is normally shared across every leg in one event. A non-equivalent or unclear pair is NEVER suppressed, only labelled — read resolution_warning before treating spread_pp as a real cross-venue disagreement rather than a difference in contract. spread.resolution_audit carries the full underlying audit (source/timestamp/timezone/precision/evidence_standard/void_handling for both sides) and spread.resolution_source_note is the standing disclosure explaining the methodology and its "unclear" caveat. Call resolution_audit/resolution_diff directly for a specific pair of legs if you need a non-representative-sample breakdown. skipped_cross_type / skipped_cross_subtype counters expose how many leg-pair comparisons were dropped (cross-type = metric_type mismatch like MoM vs YoY; cross-subtype = inequality mismatch like cum_ge vs cum_le). Real cross-venue spreads are rarer than the macro-shortcut list suggests — most pre-mapped topics return compatibility_warning today; pre-mapped ≠ tradeable.
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Subject to compare. Canonical keys: fed | btc | eth | cpi | gdp | sp500 | recession | next_pope | next_uk_pm | next_israel_pm | 2028_president — but aliases and keywords resolve too ("bitcoin", "fed rate decision", "ethereum", "inflation", "s&p 500", "us recession", "next pope", "2028 election"). Check resolution.topic_matched_by in the response: "exact"/"alias" is a curated pairing, "phrase"/"token" is a keyword guess. | |
| kalshi_event_ticker | No | Explicit Kalshi event ticker, e.g. "KXFED-26OCT". Overrides the topic-mapped Kalshi side. | |
| polymarket_event_slug | No | Explicit Polymarket event slug, e.g. "fed-decision-in-june-825". Overrides the topic-mapped Polymarket side. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description is exceptionally transparent about behavioral nuances: it discloses the two modes, the matching logic, the safety fields and their meanings, fee calculation details with verification dates, resolution equivalence methodology, and historical changes that affect interpretation (e.g., fleet #1927 correcting gas modeling). It also explicitly states limitations (spread-crossing cost not modeled, no live order book). Annotations already indicate read-only/idempotent, and the description adds extensive context without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely verbose—it reads as a full technical spec with historical fleet notes and extensive caveats. While it is front-loaded with the core purpose and organized with section headers, its length (several hundred words) is far from concise. Every sentence adds information, but the sheer volume makes it heavy for an agent to parse. A more distilled version would be more efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity and the absence of an output schema, the description is remarkably complete. It explains all response fields (spread, compatibility_warning, fees, resolution_audit, etc.), defines every safety code, describes fee formulas with verification dates, and covers both modes and edge cases. An agent has everything needed to invoke the tool correctly and interpret results, even without an output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Although the schema already provides 100% coverage of parameter descriptions, the tool description adds substantial semantic value: it explains the topic aliases and keywords, how resolution.topic_matched_by distinguishes exact/alias from phrase/token guesses, and the behavior of explicit overrides. It also clarifies that unresolvable topics return a specific error rather than falling back. This goes well beyond the schema's baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Cross-venue spread between Kalshi and Polymarket for the same resolving question.' It clearly defines the tool's function and distinguishes it from single-venue tools by its focus on cross-venue comparison. The two operational modes are explicitly described, leaving no ambiguity about what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains when to use the tool (for cross-venue spread analysis) and details both usage modes with examples. It provides clear guidance on how to interpret results and warns that 'pre-mapped ≠ tradeable'. It also points to alternative tools like resolution_audit/resolution_diff for specific needs. However, it does not explicitly state when NOT to use this tool in favor of siblings, so it stops short of a full when-not/alternatives matrix.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
recallRecallARead-onlyIdempotentInspect
Retrieve a value previously saved via remember, or list all saved keys (omit the key argument). Use to look up context the agent stored earlier — the user's target ticker, an address, prior research notes — without re-deriving it from scratch. Scoped to your identifier (anonymous IP, BYO key hash, or account ID). Pair with remember to save, forget to delete.
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | Alias for key. | |
| key | No | Memory key to retrieve (omit to list all keys). Accepts name, k, label as aliases. | |
| name | No | Alias for key. | |
| label | No | Alias for key. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered and the bar is lower. The description adds genuine value by disclosing the dual behavior (retrieve vs. list-all-keys when omitting the argument) and the scoping to the agent's identifier (anonymous IP, BYO key hash, or account ID). No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with zero waste: core action first, then usage context with examples, then scoping and sibling pairing. Every sentence earns its place, and the key behavioral distinction (omit key to list all) is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a low-complexity read/list tool with annotations carrying the safety profile and a schema fully documenting the parameters, nothing an agent needs to call it correctly is missing. The dual behavior, scoping, and sibling relationship are all covered despite the absence of an output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all four parameters (which are all aliases for the same key). The description's note about omitting the key to list all keys is mirrored in the schema, so it adds little beyond what structured data already provides. Baseline 3 is appropriate since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Retrieve a value previously saved via remember, or list all saved keys') with concrete use examples (target ticker, address, research notes). It explicitly differentiates from siblings by naming remember (save) and forget (delete), so an agent can distinguish recall without inspecting other schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context on when to use the tool ('look up context the agent stored earlier... without re-deriving it from scratch') and routes to alternatives ('Pair with remember to save, forget to delete'). It lacks an explicit when-not statement, but the scoping and sibling pairing make the intended usage unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
recent_alertsRecent AlertsARead-onlyIdempotentInspect
Pull fired events from your subscription feed. Returns the most recent alerts the evaluator has written to your persisted feed — each carries source, citation_uri (pipeworx:// when available), and the raw event payload. Filter by type (e.g. "sec_8k") and/or since (ISO timestamp). Set mark_read:true to flag returned events read so the next call only shows newer ones. Polls work fine; the same feed is also at GET registry.pipeworx.io/alerts.json for scripts and dashboards.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Optional — filter to one subscription type. | |
| limit | No | Max events to return (1-200, default 50). | |
| since | No | Optional ISO timestamp — return events fired_at >= this time. | |
| mark_read | No | Flag the returned events read in the same call (default false). | |
| unread_only | No | Return only events where read_at is null (default false). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish readOnlyHint, openWorldHint, idempotentHint, and non-destructive behavior. The description adds genuinely useful behavioral context beyond that: return fields (source, citation_uri, raw payload), the mark_read side effect that affects subsequent calls, and polling suitability. No contradiction with annotations is present.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four dense sentences, each earning its place: the opening states the core action, the second details return contents, the third covers filtering and mark_read semantics, and the fourth mentions polling and an alternative endpoint. It is front-loaded and contains no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Without an output schema, the description compensates by describing the return payload. It also covers filtering, mark_read behavior, polling, and alternative access. Minor omissions like limit defaults and unread_only details are already present in the schema, so the description is nearly complete for a read-oriented tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds value beyond the schema by giving a concrete type example ('sec_8k'), specifying ISO format for since, and explaining the consequence of mark_read ('so the next call only shows newer ones'). This exceeds what the schema descriptions alone provide.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource ('Pull fired events from your subscription feed') and clarifies it returns recent alerts from the evaluator's persisted feed. It is conceptually distinct from siblings like list_subscriptions or recent_changes, but it never explicitly names or differentiates those alternative tools, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear usage context: it says polling works fine, explains the mark_read pattern for advancing to newer events, and points to the GET registry.pipeworx.io/alerts.json endpoint as an alternative for scripts and dashboards. However, it does not explicitly contrast with sibling MCP tools, so it lacks full when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
recent_changesRecent ChangesARead-onlyIdempotentInspect
"What's new with X" / "latest on Y" / "what happened to Z this week / month / quarter" / "updates on Acme" / "news on Tesla recently" / "what's happening with Apple" — change feed for a company in the last N days/weeks/months in ONE parallel call. Fans out to SEC EDGAR (filings since since), GDELT→GNews fallback (news mentions in window — GDELT preferred, GNews when rate-limited or 5xx), USPTO (patents granted; PatentsView API sunset May 2025 so this soft-fails until reactivated). since accepts ISO date ("2026-04-01") or relative shorthand ("7d", "30d", "3m", "1y"). Returns structured changes[] grouped by source + total_changes count + pipeworx:// citation URIs. Use entity_profile instead when you want the static profile (filings + fundamentals + LEI + patents) regardless of window.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Entity type. Only "company" supported today. | |
| since | Yes | Window start — ISO date ("2026-04-01") or relative ("7d", "30d", "3m", "1y"). Use "30d" or "1m" for typical monitoring. | |
| value | Yes | Ticker (e.g., "AAPL") or zero-padded CIK (e.g., "0000320193"). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: it fans out to multiple sources in parallel, has a GDELT→GNews fallback, notes the PatentsView API sunset causing soft-fail, and describes the return shape (changes[] grouped by source, total_changes, pipeworx:// citation URIs). It doesn't detail pagination or rate limits, but the disclosed behavior is substantial.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but well-organized: example queries first, then the core function, then source details, then parameter formats, then return shape, then the sibling distinction. Every sentence adds information, though the source-fallback details make it slightly long. The front-loading of example queries is effective for an agent scanning for intent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only, idempotent tool with 100% schema coverage and no output schema, the description covers the main things an agent needs: what it does, what inputs look like, what sources it hits, and when to use the sibling instead. It doesn't specify pagination or exact output field types, but the return shape is summarized and the annotations cover safety. A small gap is not explaining how 'changes' are structured beyond grouping by source, but this is acceptable given the tool's complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all three parameters. The description adds meaning by explaining the `since` accepted formats (ISO date or relative shorthand) and giving typical usage ('30d' or '1m'), plus clarifying that `value` can be a ticker or zero-padded CIK. This goes beyond the schema's descriptions and helps an agent construct valid calls.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with concrete natural-language queries ('What's new with X', 'latest on Y') and then states the exact function: a change feed for a company over a time window in one parallel call. It names the data sources (SEC EDGAR, GDELT→GNews, USPTO) and explicitly contrasts with entity_profile, so an agent can distinguish it from the closest sibling without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance via example queries, specifies the `since` window formats, and states the alternative: 'Use entity_profile instead when you want the static profile... regardless of window.' It also discloses fallback behavior (GDELT preferred, GNews on rate-limit/5xx) and the USPTO soft-fail, which helps an agent decide whether this tool fits the task.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
release_calendar_marketsRelease Calendar MarketsARead-onlyIdempotentInspect
JOIN of the official release calendar (econ data, the FOMC, FDA decisions, SEC rules) against LIVE Polymarket/Kalshi markets — which scheduled releases land in the next N hours, and which live markets resolve on them. This is a POSITIONING tool, not a speed product: results are cached like every other pack (≤ 60s TTL) and there is no push/webhook — do not use this to try to beat a release, use it to see what is coming and what is already priced. CATEGORIES: econ (CPI, Employment Situation/jobs report, GDP, PCE, PPI, retail sales, housing starts, jobless claims — via fred_release_dates per known release_id, since FRED's own cross-release calendar mostly returns recent actuals, not future dates), fed (the next FOMC meeting's rate decision, via fomc_calendar), fda (PDUFA action dates + FDA advisory-committee meetings, via pdufa_catalysts / fda_adcom_calendar), sec (SEC final rules whose own DATES clause names an effective date in the window, via federal-register recent_rules — usually finds nothing in a short window since SEC rules typically take effect 30–60 days out, which is an accurate answer, not a bug), court (ALWAYS EMPTY today — court-listener has no forward-looking scheduled-hearing calendar, only filing/termination dates, so this category returns zero releases with unsupported:true rather than fabricate one). Omit categories or pass "all" for every category. MATCHING AND ITS HONESTY CONTRACT: every release is returned even when it has ZERO matched markets — a release is never dropped just because nothing on Polymarket or Kalshi resolves on it (most FDA/SEC releases will show markets:[]; that is signal, not a gap). Every matched market carries resolves_on_this_release: "true" (the venue's own close/end date sits within ~36h of the release AND the question passed a subject filter — econ and fed only), "likely" (same subject filter, but the venue closes days away from the release date), or "unclear" (a keyword hit with no date to anchor against — always true for the fda category, which has no ladder structure to check a date against). matched_by names the mechanism (a Kalshi series ticker, a Polymarket search query, or an FDA keyword probe) so a caller can judge the match rather than trust a label. scheduled_at carries both utc and et; econ releases use the standing BLS/Census 8:30am ET convention (FRED's calendar itself has no clock time), FOMC decisions use the 2:00pm ET convention, and FDA/SEC dates are date_only:true (no reliable clock time exists for either). DO NOT treat a matched market as a real arbitrage or a settled fact on its own — a market question sharing tokens with a release name is not proof it settles on that release's own published number. Call resolution_audit / resolution_diff (fleet #1909) on a specific market before sizing anything here. An empty window (zero releases across every requested category) returns the SAME shape as a populated one — release_count:0, releases:[] — plus empty_reason:"no_releases_in_window" and a hint telling you to widen, so you never branch on the response shape and never have to guess whether zero means "nothing is scheduled" or "the lookup failed". Econ releases especially cluster on specific dates each month, so a 48h window often straddles a dead stretch.
| Name | Required | Description | Default |
|---|---|---|---|
| hours | No | Look-ahead window in hours from now. Default 48. Capped at 720 (30 days) — econ/fed releases are dated weeks apart, so a short window is often empty; widen rather than assume nothing is scheduled. | |
| categories | No | Comma or space separated subset of econ|fed|fda|sec|court, or "all" (default). E.g. "econ,fed" or "fda". |
Output Schema
| Name | Required | Description |
|---|---|---|
| hint | No | Present ONLY on a zero-release window: what to change (usually a wider `hours`). |
| as_of | No | |
| notes | No | |
| window | No | |
| releases | No | |
| categories | No | |
| empty_reason | No | Present ONLY on a zero-release window: "no_releases_in_window". The window was queried and nothing is scheduled — this is an answer, not a failure. |
| release_count | No | |
| releases_with_matched_markets | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the readOnly/idempotent safety profile, but the description goes far beyond: ≤60s cache TTL, no push/webhook, per-category data sources and their failure modes (SEC usually finds nothing, court ALWAYS empty with unsupported:true), the resolves_on_this_release honesty contract, matched_by mechanism disclosure, and the empty-window response shape. This is unusually rich behavioral disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is front-loaded with the core definition, but the body is an extremely long block with repeated warnings (empty windows, no arbitrage, cache limits) that could be consolidated. Most sentences earn their place, but the density and repetition hurt scannability for an agent choosing a tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given an output schema exists, the description needn't explain returns, and it still covers edge cases (empty window shape, zero-match releases, date-only categories) that an agent needs to call and interpret this correctly. Nothing material is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the CATEGORIES discussion adds real meaning the schema does not: what each category actually queries (fred_release_dates, fomc_calendar, pdufa_catalysts, federal-register recent_rules), why court is always empty, and the default semantics of omitting categories. That compensates above baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence names the exact operation — a JOIN of the official release calendar against live Polymarket/Kalshi markets — and states the output intent (which releases land in the next N hours and which markets resolve on them). It explicitly frames itself as a POSITIONING tool, distinguishing it from sibling speed/resolution tools like resolution_audit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It says when to use it ('see what is coming and what is already priced'), when NOT to use it ('do not use this to try to beat a release', no push/webhook), and routes the caller to resolution_audit / resolution_diff before sizing positions. Sibling alternatives and exclusions are both explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
rememberRememberAIdempotentInspect
Save data the agent will need to reuse later — across this conversation or across sessions. Use when you discover something worth carrying forward (a resolved ticker, a target address, a user preference, a research subject) so you don't have to look it up again. Stored as a key-value pair scoped by your identifier. Authenticated users get persistent memory; anonymous sessions retain memory for 24 hours. Pair with recall to retrieve later, forget to delete.
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | Alias for key. | |
| v | No | Alias for value. | |
| key | Yes | Memory key (e.g., "subject_property", "target_ticker", "user_preference"). Accepts name, k, label as aliases. | |
| data | No | Alias for value. | |
| name | No | Alias for key. | |
| text | No | Alias for value. | |
| label | No | Alias for key. | |
| value | Yes | Value to store (any text — findings, addresses, preferences, notes). Accepts content, text, data, v as aliases; a non-string value is stored as JSON. | |
| content | No | Alias for value. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true and destructiveHint=false, so the description adds useful extra context: memory is scoped by identifier, authenticated users get persistence, and anonymous sessions retain memory for 24 hours. No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact, front-loaded with the core purpose, and every sentence adds value: usage trigger, storage model, persistence behavior, and related tools. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple write-tool nature, the absence of an output schema is not a serious gap. The description covers what to store, when to store it, persistence limits, and sibling operations. A marginally stronger version would state return behavior or overwrite semantics.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the schema already documents the key/value aliases and examples. The description only restates the key-value concept without adding deeper semantics, so it meets but does not exceed the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Save data the agent will need to reuse later.' It clearly differentiates itself from sibling tools by naming recall (retrieve) and forget (delete), so an agent can tell which operation to invoke.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit trigger condition: 'Use when you discover something worth carrying forward...' and lists concrete examples. It does not state when not to use it, but the guidance is clear enough for most cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
research_rowResearch RowARead-onlyIdempotentInspect
Claygent-style per-row research: answer ONE question about ONE company and return a JSON object matching your output_schema, with every field wrapped in its own evidence — {value, evidence_url, quote, status}. status is NEVER self-reported by the model: "found" means this code independently verified the model's quote is a VERBATIM substring of text actually fetched; "inferred" means a value was given but the quote could not be verified; "not_established" means no source answered the field, and its value is always null — never guessed, never a blended score. Sources: "web" fetches the company's own site (entity.domain required — homepage, /about, /leadership) via fetch_url; "catalog" checks entity_profile (SEC EDGAR; resolved:false for a private company is expected, not a failure); "both" (default) tries both. max_cost (USD, default 0.02, max 0.50) scales how many pages are fetched and refuses up front if it is too small to pay for even one extraction call (floor $0.002) — never silently overspends. A row where every source comes back empty costs nothing: every field is mechanically not_established with NO model call made. For a boolean/derived field (e.g. "does this company sell to healthcare"), the quote only has to SUPPORT the value — a descriptive sentence about customers/products counts, the source need not state the answer verbatim. leadership_page_status ("fetched"|"not_found"|"not_attempted", plus leadership_note) says plainly whether a leadership/team page was actually read, so a named-person field (head_of_sales) coming back not_established is distinguishable from "this company just doesn't publish one" vs. "we never checked". model_output_empty:true means the model returned nothing usable (a transport/budget problem) — every field is not_established for THAT reason, never read as 20 individual "no" judgments. Use with a fixed question + schema across many rows for "Claygent over N companies with a hard cost cap" (composes with batch callers). For picking from a fixed label list instead of extracting open fields, use classify_row (cheaper, one model call).
| Name | Required | Description | Default |
|---|---|---|---|
| entity | Yes | The row/company to research. At least one of name/domain required. | |
| sources | No | Where to look: "web" (company site only), "catalog" (entity_profile only), "both" (default). | |
| max_cost | No | Cost ceiling in US dollars for this one row. Default 0.02, max 0.50, minimum viable 0.002 (below that the call is refused rather than silently exceeding it). | |
| question | Yes | The question to answer about this company, in natural language, e.g. "Does this company sell to healthcare, and who is the head of sales?" | |
| output_schema | Yes | JSON Schema object naming the fields to extract, e.g. {"properties":{"sells_to_healthcare":{"type":"boolean"},"head_of_sales":{"type":"string"}}}. Up to 20 fields. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the read-only and open-world annotations, the description discloses the evidence verification model, status semantics, cost refusal behavior, zero-cost empty-source behavior, and failure signals like model_output_empty. It also distinguishes a legitimately absent leadership page from a page that was never checked.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but front-loaded with the core operation and evidence contract. Every sentence carries useful information, though the single long paragraph could be easier to scan if split by source, cost, and status behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex, multi-source research tool with no output schema, it covers return shape, verification statuses, cost caps, source behavior, and common failure modes. An agent has enough information to invoke it correctly and interpret ambiguous-looking results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Even though the schema already documents parameters, the description adds operational meaning: max_cost scales page fetching and is refused below a floor rather than overspent, web requires entity.domain, and output_schema fields are wrapped in value/evidence_url/quote/status.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource, answering one question about one company and returning evidence-wrapped JSON. It clearly distinguishes the tool from classify_row and explains that the output matches a caller-supplied schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says when to use this tool: fixed question plus schema across many rows with a hard cost cap, and when to use the alternative classify_row for fixed-label classification. It also explains source-selection conditions for web, catalog, and both.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
resolution_auditResolution AuditARead-onlyIdempotentInspect
Extract the settlement clause of a single Polymarket or Kalshi market: who publishes the settling number (source), the clock time + timezone it is taken at, the precision of the computation (e.g. "1-minute candle close" vs "60-second trailing average" vs "election outcome"), the evidence standard (official_source | consensus_reporting | any_credible_report | unspecified), and void_handling (cancellation/postponement settlement — reused verbatim from bet_research's cancellation_rule detector, not re-derived). Parses Polymarket's description field (fetched via polymarket_market) or Kalshi's rules_primary + rules_secondary fields (fetched via kalshi_market) with regex + a small vocabulary — no LLM pass, so an unusual clause reports confidence:"low" rather than a guess. Pass market as a Polymarket slug/URL or a Kalshi market ticker (e.g. "KXBTCD-26SEP1317-T66999.99"); a Kalshi EVENT ticker (e.g. "KXBTCD-26SEP1317") also works — it picks one representative market under that event, since the settlement mechanism is normally shared across all strikes/legs in one event. Use this before treating a polymarket_kalshi_spread row as a real arbitrage: two ladders that look alike can settle on different sources, at different times, with different precision — this tool is how you check. Pair with resolution_diff to compare two markets directly. KNOWN GAP: idiosyncratic phrasing that doesn't match the vocabulary returns confidence:"low" and evidence_standard:"unspecified" rather than an LLM-guessed answer.
| Name | Required | Description | Default |
|---|---|---|---|
| venue | Yes | Which venue to fetch the market from. | |
| market | Yes | Polymarket market slug or URL, OR a Kalshi market ticker (preferred) or event ticker (falls back to a representative market under that event). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as readOnly, idempotent, and non-destructive, and the description adds substantial behavioral detail beyond that: deterministic regex + vocabulary with no LLM pass, confidence:'low' for unusual clauses, reuse of bet_research's cancellation_rule detector, and the known gap of returning evidence_standard:'unspecified' rather than guessing. No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but dense and front-loaded: the first sentence carries the core purpose and output fields, then input semantics, usage context, companion tool, and known gap follow in logical order. Every sentence contributes necessary information with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the full burden of explaining what the agent gets back. It enumerates the extracted fields, the confidence fallback, the evidence_standard enum values, void_handling reuse, and the known limitation, making the tool fully callable without guessing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the description still adds meaningful value: concrete examples for Polymarket slugs and Kalshi tickers, clarification that Kalshi event tickers fall back to a representative market, and why that fallback is safe. This goes well beyond the bare schema properties.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Extract the settlement clause of a single Polymarket or Kalshi market.' It enumerates exactly which attributes are extracted (source, clock time, precision, evidence standard, void handling) and explicitly distinguishes this tool from resolution_diff and polymarket_kalshi_spread, making sibling differentiation unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use the tool: before treating a polymarket_kalshi_spread row as real arbitrage. It also names the companion tool resolution_diff for comparing two markets, and explains the Kalshi event-ticker fallback behavior, leaving no ambiguity about when or how to invoke it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
resolution_diffResolution DiffARead-onlyIdempotentInspect
Field-by-field diff of TWO markets' settlement clauses (one from each of a and b; either can be Polymarket or Kalshi) — runs resolution_audit on both sides and compares source, settle time, precision, and evidence standard. Returns equivalent: "true" only when both sides parsed with enough confidence to compare AND no field conflicts; "false" when a specific conflict was found (differing_fields names which — e.g. ["source","settle_time"] for a Polymarket Bitcoin market settling on Binance's 1-minute candle at noon ET versus a Kalshi KXBTCD market settling on CF Benchmarks' BRTI 60-second average at 5pm EDT — SAME asset, DIFFERENT contract); "unclear" when one or both sides could not be confidently parsed (an absence of evidence is not evidence of equivalence — read raw_clause yourself in that case). Only flags a field as differing when BOTH sides gave a SPECIFIC comparable answer — a named source (e.g. "Associated Press, Fox News, NBC") against a generic one (e.g. Kalshi's "consensus of media organizations") is treated as the same evidence standard, not a conflict, since that is standard election-market boilerplate on both venues. Use this before sizing a polymarket_kalshi_spread pair as a real cross-venue arb, or standalone to sanity-check any two markets you suspect settle on different things.
| Name | Required | Description | Default |
|---|---|---|---|
| a | Yes | First market to compare. | |
| b | Yes | Second market to compare. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint=falsechers. The description adds important behavioral nuance beyond those hints: it explains the three-way equivalence outcome, the confidence threshold for comparing, and the specific-versus-generic source rule that prevents false conflicts. It also discloses that the tool internally runs resolution_audit, which is useful to set expectations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is information-dense and front-loaded with the core purpose, but it is long and contains a lengthy parenthetical example and an extended heuristic explanation. Every point is relevant, but the phrasing is verbose and could be tightened or restructured with bullet-like separators. It earns its content but sacrifices conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, so the description carries the burden of explaining return values, and it does so thoroughly: it explains the possible values of `equivalent` (true/false/unclear), mentions `differing_fields`, and instructs the caller to read `raw_clause` in unclear cases. It also covers the non-conflict heuristic. The only gap is not fully specifying the entire output structure or exact field locations, but the guidance is sufficient for the agent to decide when to call it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with both parameters described as 'First market to compare' and 'Second market to compare.' The description adds that they are markets on either Polymarket or Kalshi and that the tool runs resolution_audit on both sides, which slightly clarifies roles. However, it does not add meaningful detail beyond the schema's enum and nested-object definitions, so a baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Field-by-field diff of TWO markets' settlement clauses.' It clearly states that the tool runs resolution_audit on both sides and compares source, settle time, precision, and evidence standard, which differentiates it from the sibling resolution_audit. The three-way return value is also summarized, leaving no ambiguity about the tool's core function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit usage context: 'Use this before sizing a polymarket_kalshi_spread pair as a real cross-venue arb, or standalone to sanity-check any two markets you suspect settle on different things.' This clearly states when to use the tool. It does not, however, explicitly name alternatives or say when not to use it, so it stops short of a full when/when-not guide.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
resolve_entityResolve EntityARead-onlyIdempotentInspect
"What's the ticker for…" / "find the CIK for…" / "what's the LEI for…" / "what's the RxCUI for…" / "look up the ID for…" / "what is X's official identifier" / "who owns X" / "is X a subsidiary of Y" — resolve a user-spoken NAME to the canonical/official identifiers other tools require as input. Use FIRST whenever you have a name but need an ID. SUPPORTED TYPES: "company" (cross-source identity spine: 10-digit CIK + ticker + company_name from SEC EDGAR, legal-entity LEI from GLEIF with parent/ultimate-parent/children ownership when the LEI resolves, and security FIGI from OpenFIGI — by exact ticker map when a ticker is implied, and otherwise by name search, so NON-EQUITY instruments that never have a ticker (municipal and corporate bonds, notes, authority debt) DO resolve here; when a name matches more than one instrument it asserts nothing and returns figi_candidates to pick from, which is the correct answer to an issuer name that does not identify a single bond; every identifier is labelled with the source that established it, and an identifier that could NOT be resolved is stated explicitly under unresolved rather than omitted — accepts ticker, CIK, ISIN, or company name as input; an ISIN like "CH0038863350" resolves to the LEGAL ENTITY that issued the security via the GLEIF ISIN-to-LEI mapping, covering non-US issuers EDGAR cannot reach), "drug" (returns RxCUI + ingredient + brand from RxNorm + pipeworx://rxnorm/concept/{rxcui} citation; accepts brand or generic name). LEI/FIGI enrichment degrades gracefully — if GLEIF or OpenFIGI is unavailable, the EDGAR identifiers still return. Each call cascades through several lookup endpoints internally — using resolve_entity replaces 2-3 manual lookups.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Entity type: "company" or "drug". | |
| value | Yes | For company: ticker (AAPL), CIK (0000320193), or name. For drug: brand or generic name (e.g., "ozempic", "metformin"). Pass the ENTITY NAME ONLY — for a bond that is the ISSUER exactly as printed ("NEW YORK ST DORM AUTH"), never the question's full noun phrase ("NEW YORK ST DORM AUTH revenue bonds"): the FIGI lookup matches instrument names, so trailing security-class words match nothing. | |
| country | No | OPTIONAL ISO 3166-1 alpha-2 of the country whose business register you mean ("NO", "FI", "JP", "GB", "FR", "EE", "BR"). Narrows the national-register fan-out and is often the difference between the right company and a US namesake — "Apple" with country "NO" is a Norwegian company, not Apple Inc. Omitting it searches every register we can name, which is the right default when you do not know. company only; ignored for drug. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ids | Yes | Every identifier established: cik, ticker, company_name, lei, figi, isin, cusip, register_id, register_country. A key absent here appears in `unresolved` with a reason — never silently dropped. |
| type | Yes | |
| brand | No | |
| notes | No | |
| query | Yes | |
| related | No | Entities that collapsed INTO the match, each carrying `collapsed_by`. |
| sources | Yes | Per-identifier provenance. Every key in `ids` has a matching key here. |
| resolved | Yes | At least one identifier was established. Read `match_status` and `unresolved` for WHICH — a company can be resolved in a national register with no CIK at all. |
| searched | No | EVERY register asked, with its own as-of date and row count. A register that could not be reached carries `error` — 0 rows with an error is "we could not ask", 0 rows without one is "nothing is there", and they are different answers. |
| registers | No | The matched entity as every register that carries it — the match (flagged `matched: true`) plus anything that collapsed into it. A Companies House number AND the LEI that crosswalks to it are the SAME answer, not rivals. |
| resources | No | |
| candidates | No | Rivals, best first. Populated on "ambiguous" and on "matched" alike. |
| ingredient | No | |
| unresolved | Yes | Per-identifier reason an id could NOT be established — the honest twin of `ids`. |
| cik_withheld | No | A CIK that came back from a FUZZY SEC name match and is NOT asserted, because the spine matched a stronger non-US candidate. The number is here so a caller who wanted the US filer can still use it; what changed is that we no longer claim it IS the answer. See `unresolved.cik` for the reason. |
| match_status | No | The headline to branch on. "ambiguous" is an ANSWER, not a failure: two companies matched the name equally well and both are in `candidates`. "no_match" means every register in `searched` was asked and none carried it. "incomplete" means one of them could NOT be asked (it carries an `error` in `searched[]`), so the candidate set is short by an unknown amount and no id is asserted — distinct from "ambiguous" because a RETRY is what resolves it, not a narrower query; `fanout_incomplete` names the unreachable registers and carries, under `withheld_match`, the candidate that would have been returned on a complete fan-out. |
| figi_withheld | No | A FIGI that matched this name in OpenFIGI (`figi_match: "name_search"`) and is NOT asserted, because `match_status` is "incomplete": a name search cannot tell a company apart from a security carrying its name, and the registers that would have settled it are the ones we could not ask. A `ticker_map` FIGI is never withheld this way — it is corroborated by the resolved ticker it came from. Carried so a caller who accepts the caveat can use it; see `unresolved.figi`, and retry, since a transiently rate-limited register completes on the next call. |
| match_scoring | No | The margin rule's own inputs, so a caller can see WHY it fell where it did. |
| sec_alternatives | No | EDGAR's own discarded near-misses on a name match, surfaced instead of dropped. |
| fanout_incomplete | No | Present IFF at least one register in `searched[]` carried an `error` — set even when `match_status` stayed "ambiguous". `withheld_match` is the candidate this call declined to ASSERT because a register was missing, carried rather than discarded so a caller who accepts the caveat can still use it. |
| match_explanation | No | Plain words. Always present when the spine ran, and required on "ambiguous" and "no_match". |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With readOnly/openWorld/idempotent annotations already covering the safety profile, the description still adds real behavioral context: graceful degradation when GLEIF or OpenFIGI is unavailable, that unresolved identifiers are surfaced under `unresolved` rather than omitted, that ambiguous instrument names assert nothing and return `figi_candidates`, and that each call cascades through several endpoints. It doesn't discuss latency/rate limits, but the additions are substantive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Most content earns its place for a genuinely complex multi-source tool, but the presentation is a wall of nested parentheticals that is hard to parse, and the critical routing rule ('Use FIRST') is buried after eight example questions. Front-loading the purpose and constraints would markedly improve scannability.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool that cascades across EDGAR, GLEIF, OpenFIGI and RxNorm, the description covers supported entity types, identifier sources, ambiguity handling, degradation, and the optional country narrowing. Output schema exists, so return values need not be re-explained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is already 100%, but the description goes beyond it: it adds ISIN ('CH0038863350') as a valid company input, which the schema omits, and clarifies the semantic split between the 'company' and 'drug' types. These additions measurably exceed the baseline 3 for fully documented schemas.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a precise verb+resource — resolve a user-spoken NAME to canonical/official identifiers that other tools require as input — and enumerates the concrete identifier types (CIK, ticker, LEI, FIGI, RxCUI). An agent can tell it apart from lookups like company_facts or entity_profile without opening a schema, and the example phrasings anchor the intent.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a strong routing rule — 'Use FIRST whenever you have a name but need an ID' — plus the question patterns that should trigger it and notes that it replaces 2-3 manual lookups. It does not explicitly name an alternative sibling or state when not to use it, so it falls short of the 5 bar.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
scan_competitor_ai_presenceScan Competitor AI PresenceARead-onlyIdempotentInspect
Compare AI visibility across multiple entities side-by-side. Probes each entity (your brand + N competitors) with ai_visibility_check, ranks by score, surfaces which is most/least recognized. Useful for competitive AI-marketing audits: "does Claude know about us as well as our competitors?". Returns ranked list with score, confidence, signal density per entity.
| Name | Required | Description | Default |
|---|---|---|---|
| models | No | Which models to probe. Supported: "workers-ai" (free default), "anthropic" (requires _apiKey). Omit for just workers-ai. | |
| _apiKey | No | Optional Anthropic API key — only if "anthropic" is in models. Passed to api.anthropic.com per probe. | |
| context | No | Optional shared context applied to every probe (e.g. "B2B SaaS", "Boston restaurant"). Disambiguates common names. | |
| entities | Yes | Array of 2-8 entities to compare (brand/business/product names). First entry treated as the "subject" for narrative; rest are competitors. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnlyHint, idempotentHint, and destructiveHint, so the description only needs to add context. It explains the mechanism (probes each entity with ai_visibility_check) and the output (ranked list with score, confidence, signal density), which is useful but not extensive. 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with no filler. The core purpose is front-loaded ('Compare AI visibility across multiple entities side-by-side'), followed by mechanism and use case. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the schema documents all parameters and the description explains the output format and purpose, the tool is adequately described. Minor details like exact ranking criteria are not essential for correct invocation. The description is complete enough for an agent to understand what the tool does and when to use it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description covers all 4 parameters at 100%, so the baseline is 3. The description adds no extra parameter semantics beyond what the schema already explains, so no additional value is provided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Compare' and the resource 'AI visibility across multiple entities', and explicitly differentiates from siblings by mentioning it uses ai_visibility_check and is for competitive audits. It is specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a concrete use case ('competitive AI-marketing audits') and a sample question ('does Claude know about us as well as our competitors?'). It does not explicitly list exclusions or alternative tools, but the purpose is distinct enough that an agent can infer when to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
scan_dependencyScan DependencyARead-onlyIdempotentInspect
Composite "should I add this npm package to my project" check in ONE call — fans out across deps.dev (license + advisories + version history) and bundlephobia (gzipped/minified bundle size, dependency count, ESM/tree-shake support). Use whenever an agent asks "is X safe / popular / small" or "what does adding lodash cost me". Returns a summary block (is_latest, license, published_at, advisory_count, bundle_kb_min, bundle_kb_gz, dependency_count, has_esm, tree_shakeable), per-advisory detail, links, and a list of recent alternative versions. NPM ecosystem only in v1; PyPI / Maven / Cargo / Go fall under deps.dev:version directly. Partial failures degrade gracefully — bundlephobia's first measurement on a new version can take 5-30s; sources_failed will list it if it times out, the rest still returns.
| Name | Required | Description | Default |
|---|---|---|---|
| package | Yes | npm package name. Scoped packages (e.g. "@types/node") are accepted. | |
| version | No | Specific version to check (e.g., "18.3.1"). Defaults to the latest published version when omitted. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint false. The description adds significant behavioral context beyond annotations: it explains partial failure handling, the 5-30s first-measurement latency on bundlephobia, and that sources_failed will list timeouts while other data still returns. 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but efficient, opening with the core composite purpose, then listing return fields, then noting ecosystem scope and failure behavior. Every sentence earns its place; no fluff or redundancy, and the most critical usage guidance is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description thoroughly enumerates the return structure (summary block fields, per-advisory detail, links, alternative versions) and error behavior. It also covers latency expectations and scope limitations, leaving no gap for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both 'package' and 'version' including defaults and scoped package acceptance. The description does not add any additional parameter semantics beyond what the schema provides; the baseline of 3 applies since the schema carries the full burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: a composite check for 'should I add this npm package' covering license, advisories, version history, and bundle size via deps.dev and bundlephobia. It specifies the resource (npm packages) and the exact questions it answers, distinguishing it from siblings like scan_competitor_ai_presence and the deps.dev:version fallback.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use: whenever an agent asks 'is X safe / popular / small' or 'what does adding lodash cost me'. Also provides an exclusion: NPM ecosystem only in v1, with PyPI/Maven/Cargo/Go falling under deps.dev:version directly, giving a clear alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_withinSearch Within a SourceARead-onlyIdempotentInspect
Semantic search INSIDE a fetched record. Pass the text you already pulled (e.g. a SEC 10-K body, an article, a long tool result) plus a natural-language query; get back the top-N passages with character offsets and similarity scores. Use when the record is too big to cram into the prompt — search_within saves context, returns only the passages that matter, and every passage carries an offset so the agent can verify a verbatim quote. Pairs with ask_pipeworx_grounded: fetch with the gateway, ground over the relevant passages instead of the whole document. BGE-base-en embeddings + cosine over 500-char overlapping windows; cap is 200K chars (longer inputs are truncated and flagged).
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | The document text to search inside (max ~200K chars). | |
| limit | No | Max passages to return (1-20, default 5). | |
| query | Yes | Natural-language query — what passages do you want? E.g. "supply-chain risk", "fiscal year 2024 revenue", "drug interactions with warfarin". |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds meaningful behavioral context: BGE-base-en embeddings, cosine similarity, 500-char overlapping windows, 200K char cap, truncation flagging, and character offsets for verification. This goes beyond the annotations and helps the agent predict output characteristics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but every sentence earns its place: it states the core function, the use case, the pairing with a sibling, the embedding/algorithm details, and the input cap. It is front-loaded with the most important information and has no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only search tool with 100% schema coverage and no output schema, the description is complete. It explains the return characteristics (top-N passages, offsets, similarity scores), the algorithm, the size cap, and the truncation behavior. An agent has everything needed to decide when to call it and what to expect.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters. The description adds context about the 200K char cap and the nature of the query, but it doesn't add much beyond the schema. Baseline 3 is appropriate because the schema carries the parameter documentation burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: semantic search inside a fetched record, with a clear contrast to alternatives. It names the sibling ask_pipeworx_grounded and explains the pairing, so an agent can distinguish this tool from the broader ask_pipeworx family without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use it: when the record is too big to fit in the prompt, and it names the alternative ask_pipeworx_grounded for grounding over relevant passages. It also gives a concrete workflow: fetch with the gateway, then search within. This is explicit usage guidance with an alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sponsor_to_filerSponsor To FilerARead-onlyIdempotentInspect
Resolve an organization NAME — especially a clinical-trial sponsor, drug developer, or operating subsidiary — to the US-listed public FILER that reports it (ticker + SEC CIK). Built for the join that plain ticker/name lookup fails: trial registries (ClinicalTrials.gov) name operating subsidiaries ("Merck Sharp and Dohme"), while SEC names the listed parent ("Merck & Co", MRK). This tool bridges that gap and, crucially, tells you WHY a name does not resolve instead of collapsing every miss to "not found". Returns a status: "resolved" (name is itself a US-listed filer), "resolved_via_parent" (name is a subsidiary; resolved to its listed parent, with evidence + confidence), "us_registrant_unlisted" (has an SEC CIK but no public listing and no listed parent — typically a private company that filed a Form D or draft registration), or "no_us_registrant" (no US SEC presence at all — typically a non-US-listed or foreign private company). Use before joining trial sponsors to public financials, ownership, or filings.
| Name | Required | Description | Default |
|---|---|---|---|
| sponsor | Yes | Organization name to resolve — a trial sponsor, drug developer, or company name, e.g. "Merck Sharp and Dohme", "Lexeo Therapeutics", "Dizal Pharmaceuticals". |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (read-only, open-world, idempotent), the description discloses key behavioral traits: it returns four distinct statuses ('resolved', 'resolved_via_parent', 'us_registrant_unlisted', 'no_us_registrant'), explains what each means, and emphasizes that it explains why a name does not resolve instead of just returning 'not found'. This goes well beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the main purpose and efficiently covers key details. While verbose, every sentence is informative and necessary to fully convey the tool's unique value and behavior. It could be slightly shorter but is well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite lacking an output schema, the description fully explains the return values and their meanings. It also provides the problem context and use case, making the tool's purpose and behavior completely clear. No additional context is needed for an agent to select and invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already describes the single 'sponsor' parameter with 100% coverage and examples. The description adds value by clarifying the types of names accepted (trial sponsors, drug developers, subsidiaries) and providing concrete examples, enriching understanding beyond the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: resolving an organization name (especially clinical-trial sponsors) to the US-listed public filer (ticker + CIK). It explicitly differentiates itself from plain ticker/name lookup by addressing the subsidiary-parent naming gap, making its specific use case clear.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains when to use this tool: for joining trial sponsors to public financials when plain lookups fail. It provides context about the problem (trial registries using subsidiary names, SEC using parent names) but does not explicitly compare with sibling tools like 'edgar_ticker_to_cik' or 'resolve_entity', though the distinct purpose is implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
subscribeSubscribe to AlertsAIdempotentInspect
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"}), "patent_grant" (new USPTO grants for an applicant), "clinical_trial" (new/updated ClinicalTrials.gov studies), "form_d" (new SEC Form D fundraise notices — params:{state?, industry?, min_amount?, exemption?}, all optional), "news_keyword" (GDELT keyword news alerts, metadata+link only — params:{query, lang?, domains?}), "job_post" (new public job-board postings — params:{ats?, board_token?} or {domain?}, plus optional title_query/location_query), "tool_diff" (re-runs any read-only tool on a schedule and fires on change — params:{tool, args?, fields[], schedule}), "new_entity" (new business registrations from a state business-entity registry — params:{state:"CO", name_query?, entity_type?}), "tech_change" (a watched domain's website technology stack adds or drops a technology — params:{domains:["acme.com"], technologies?}). 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).
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Subscription type. | |
| params | Yes | 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). form_d: {state?:"CA", industry?:"Biotechnology", min_amount?:500000, exemption?:"06B"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:"\"semiconductor sanctions\"", lang?:"eng", domains?:["reuters.com"]} (query required). job_post: EITHER {ats:"greenhouse", board_token:"acme"} (exact board) OR {domain:"acme.com"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:"form5500", args?:{...}, fields:["headcount"], schedule:"daily"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule "hourly" needs the paid tier. new_entity: {state:"CO", name_query?:"dental", entity_type?:"limited liability"} — state is required and must be one of FL, NY, CO, OR, CT, TX, PA. tech_change: {domains:["acme.com","example.org"], technologies?:["Shopify","Segment"]} — domains required (1-200), technologies optional (exact names, case-insensitive) to narrow which detected technologies alert. Unknown keys in form_d/news_keyword/job_post/tool_diff/new_entity/tech_change params are rejected at subscribe time. | |
| delivery | No | 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. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial behavioral context beyond the annotations: OAuth requirement, webhook secret returned once and HMAC verification scheme, auto-disable after 10 consecutive failing runs, SMS 10/day cap and phone-verification requirement, paid-tier gating for hourly tool_diff schedules, and rejection of unknown param keys. Annotations already cover the safety profile (readOnly=false, idempotent=true, non-destructive), and the description enriches it rather than contradicting it.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose and return value in the first two sentences, which is good. However, the type catalogue and delivery detail form a very dense wall of text that substantially duplicates the 100%-covered schema, so a meaningful portion does not earn its place as description-only content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, yet the description discloses the return value (new subscription id), all subscription types with their param shapes, delivery channels, prerequisites, and failure/cap behavior. An agent has everything needed to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3, but the description adds meaning by explaining what each type actually monitors (e.g. polymarket_edge = cross-venue mispricings, tool_diff = re-run a read-only tool on schedule and fire on field change) and the form_d 'omit all to watch nationwide' semantics. This goes beyond raw param names, though it overlaps the schema's own rich descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Create a proactive monitoring subscription to a live-data event stream,' and notes it returns the new subscription id. It further enumerates all 11 subscription types, clearly setting it apart from siblings like list_subscriptions, unsubscribe, and recent_alerts.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives the key prerequisite ('Requires a Pipeworx OAuth account — anonymous + BYO cannot persist subscriptions') and clarifies the feed is 'always on — pull via recent_alerts,' implying the sibling relationship. It stops short of explicitly naming when to choose subscribe over alternatives or unsubscribing, so it isn't a full when/when-not treatment.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
suggest_questionsWhat Can I Ask Pipeworx?ARead-onlyIdempotentInspect
What can I ask Pipeworx? / what is Pipeworx good for? / what can you do? / give me ideas / show me examples / getting started / what data do you have? — the onboarding entry point for an agent that just connected and wants to know what is worth asking. Returns category-bucketed example questions (company financials, drugs & clinical trials, economics, real estate, prediction markets, weather, government & patents, science & academia, news) — each with the exact tool + argument shape that answers it, drawn from the live catalog of thousands of tools. Call with no arguments for the full spread, or pass topic (e.g. "finance", "pharma", "betting") to focus. Use this FIRST when you do not yet know what Pipeworx can do for you, or to learn how to call the meta-tools (ask_pipeworx, entity_profile, compare_entities, etc.).
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Optional focus area: finance | pharma | economics | real-estate | betting | weather | government | science | news. Omit for a cross-category spread. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal read-only, open-world, idempotent, non-destructive behavior, so the bar is lower. The description adds useful behavioral context: it is the onboarding entry point, it returns category-bucketed examples with tool+argument shapes, and it is drawn from the live catalog of thousands of tools. No contradiction 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than average because it lists many user-facing question phrasings and category examples, but this is justified for an onboarding tool. It is front-loaded with the core purpose and then gives focused usage details, though a few phrases are redundant with the schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete for a tool with one optional parameter and no output schema: it explains what the tool returns, how to do a broad query versus a focused query, and when to use it. Minor gaps such as response formatting details are not critical given the tool's purpose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the schema already documents the optional `topic` parameter and its allowed values. The description adds examples and clarifies the no-argument behavior, but this mostly restates what the schema already provides rather than adding substantive new meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states what the tool does: returns category-bucketed example questions with the exact tool and argument shape from the live catalog. It positions itself as the onboarding entry point and distinguishes its use from other tools by saying 'Use this FIRST when you do not yet know what Pipeworx can do for you.'
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context for when to use the tool: when the agent doesn't know what Pipeworx can do or wants to learn how to call meta-tools. It also explains the tradeoff between calling with no arguments for the full spread versus passing a topic to focus, but it does not explicitly name alternatives or exclusion criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unsubscribeUnsubscribe from AlertsAIdempotentInspect
Cancel a subscription by id. Ownership is enforced — you can only cancel your own subscriptions. The row is deactivated (not deleted) so its historical events stay available via recent_alerts.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Subscription id (uuid) returned by subscribe. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses critical behavioral traits beyond annotations: ownership enforcement, soft-delete behavior ('deactivated not deleted'), and the consequence that historical events remain available via recent_alerts. This adds real context beyond the readOnlyHint/destructiveHint annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action, and no filler. The ownership constraint and deactivation detail each earn their place without bloating the definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter mutation tool with annotations covering safety, the description is fully sufficient. It covers prerequisites, side effects, and downstream visibility of historical data, leaving nothing essential missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already fully describes the single parameter, including its type and origin ('Subscription id (uuid) returned by subscribe'). The description adds no extra parameter-level meaning, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description leads with a specific verb and resource: 'Cancel a subscription by id.' It clearly distinguishes from siblings like subscribe and list_subscriptions by naming the action of cancellation, and further clarifies the scope with ownership enforcement.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for use: you must have a subscription id, and you can only cancel your own subscriptions. It does not explicitly name alternatives, but the use case is unambiguous and no exclusions are needed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
validate_claimValidate ClaimARead-onlyIdempotentInspect
"Is it true that…" / "fact check" / "verify the claim that…" / "did X really…" / "was Y actually…" / "confirm or refute" / "true or false" — natural-language claim verification against authoritative sources. Use whenever the agent needs to check whether something a user said is factually correct. Company-financial claims (revenue, net income, cash for public US companies) verify via the structured SEC EDGAR + XBRL fast path with exact percent-delta math; ANY OTHER factual claim (macro statistics, rates, prices, drug data, records) automatically falls through to the grounded pipeline — routed to the right live source, answered with verbatim evidence, then judged. Returns a verdict (confirmed / approximately_correct / refuted / inconclusive / unsupported / could_not_verify), the grounded or structured actual value with pipeworx:// citation, and reasoning. IMPORTANT for callers: could_not_verify means the check did not happen (our LLM or source failed) and carries verification_error{stage,detail} — it is NOT evidence for or against the claim, and must not be shown as one. unsupported means we looked and cover no source for it. Replaces 4–6 sequential calls (NL parsing → entity resolution → data lookup → comparison).
| Name | Required | Description | Default |
|---|---|---|---|
| claim | Yes | Natural-language factual claim, e.g., "Apple's FY2024 revenue was $400 billion" or "Microsoft made about $100B in profit last year". | |
| tolerance_pct | No | Max percent deviation still graded approximately_correct (0.5–50). Overrides the tolerance implied by the claim wording — set 1–2 for hallucination detection where any material error must be refuted. Default: implied by wording, capped at 5. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, openWorld, non-destructive. The description adds significant behavioral context: the distinction between 'could_not_verify' (check did not happen) and 'unsupported' (no source exists), the exact percent-delta math for financial claims, and the return structure. It even warns callers not to treat could_not_verify as evidence. This goes far beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than ideal, but every sentence carries weight: trigger phrases, dual-path explanation, verdict list, error semantics, and the efficiency gain. It front-loads the purpose and trigger phrases, and the critical 'IMPORTANT for callers' note is placed prominently. Slight redundancy in the phrase list could be trimmed, but it's well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (two pipelines, six verdicts, error handling), the description covers everything an agent needs: when to use, what happens under the hood, what it returns, and how to interpret ambiguous outcomes. It even explains why it replaces multiple sequential calls. No gaps for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for both parameters. The description adds value by explaining tolerance_pct's role in hallucination detection (set 1–2 for strict checking) and noting the default is implied by wording capped at 5. It also provides a concrete example of the claim parameter. This goes beyond the schema's bare descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it performs natural-language claim verification with specific trigger phrases ('fact check', 'verify the claim that...'), and explicitly defines its scope: company-financial claims via SEC EDGAR/XBRL fast path, all other claims via grounded pipeline. It distinguishes itself from siblings by naming the exact function and output verdict types.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says 'Use whenever the agent needs to check whether something a user said is factually correct.' It also explains the two routing paths (structured vs grounded) and mentions it replaces 4–6 sequential calls, making it clear this is the go-to tool for claim verification without ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
9 tool updates
- Changed
ask_pipeworx1 field changed- added
Input schema / properties / packsAdded value: +{ + "description": "OPTIONAL. Restrict routing to these pack slugs (e.g. [\"sec-form-d\",\"sec-13f\"]) — the router then picks only from tools in those packs. Omit for the default full-catalog routing. Slugs come from list_packs / search_packs / https://pipeworx.io/directory; unlisted or unknown slugs are ignored and named in _meta.pack_scope.ignored, and if none of them resolves the question is routed across the whole catalog with _meta.pack_scope.full_catalog:true (never an empty answer).", + "items": { + "type": "string" + }, + "type": "array" +}
- Changed
ask_pipeworx_beta1 field changed- added
Input schema / properties / packsAdded value: +{ + "description": "OPTIONAL. Restrict routing to these pack slugs (e.g. [\"sec-form-d\",\"sec-13f\"]) — the router then picks only from tools in those packs. Omit for the default full-catalog routing. Slugs come from list_packs / search_packs / https://pipeworx.io/directory; unlisted or unknown slugs are ignored and named in _meta.pack_scope.ignored, and if none of them resolves the question is routed across the whole catalog with _meta.pack_scope.full_catalog:true (never an empty answer).", + "items": { + "type": "string" + }, + "type": "array" +}
- Changed
ask_pipeworx_grounded1 field changed- added
Input schema / properties / prefer_toolAdded value: +{ + "description": "Run this exact tool instead of letting the router choose — use a name from a previous answer's alternatives[]. Arguments are still filled from your question. Unknown names are refused, never guessed.", + "type": "string" +}
- Changed
company_facts3 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "attribute": "revenue", - "company": "AAPL", - "period": { - "fiscal_year": 2023, - "type": "annual" - } - } -]New value: +[ + { + "attribute": "revenue", + "company": "AAPL", + "period": { + "fiscal_year": 2023, + "type": "annual" + } + }, + { + "attribute": "shares_outstanding", + "company": "TSLA", + "period": { + "fiscal_quarter": 2, + "fiscal_year": 2026, + "type": "quarterly" + } + }, + { + "attribute": "capex", + "company": "TSLA", + "period": { + "fiscal_quarter": 2, + "fiscal_year": 2026, + "type": "quarterly" + } + }, + { + "attribute": "net_income", + "company": "TSLA", + "period": { + "fiscal_quarter": 4, + "fiscal_year": 2025, + "type": "quarterly" + } + } +] - changed
Input schema / properties / attribute / descriptionPrevious value: -"Which figure. \"revenue\" = total consolidated revenue; \"net_income\" = net income (loss); \"cash\" = cash and cash equivalents at the period end."New value: +"Which figure. \"revenue\" = total consolidated revenue; \"net_income\" = net income (loss); \"cash\" = cash and cash equivalents at the period end; \"gross_profit\"; \"operating_income\"; \"eps_diluted\" (diluted EPS, unit USD/shares, never derived or summed); \"capex\" (cash paid for PP&E); \"operating_cash_flow\" (net cash from operating activities); \"long_term_debt\" (the noncurrent balance-sheet line where the filer tags it, else total long-term debt — `fact.measure` says which); \"shares_outstanding\" (dei cover-page common shares, unit \"shares\", as of the COVER DATE rather than the period end)." - changed
Input schema / properties / attribute / enumPrevious value: -[ - "revenue", - "net_income", - "cash" -]New value: +[ + "revenue", + "net_income", + "cash", + "gross_profit", + "operating_income", + "eps_diluted", + "capex", + "operating_cash_flow", + "long_term_debt", + "shares_outstanding" +]
- Added
company_register_search - Changed
edgar_company_concept1 field changed- changed
Input schema / properties / concept / descriptionPrevious value: -"REQUIRED (alias `metric`). Metric name. Common: \"Revenue\" / \"Revenues\", \"NetIncomeLoss\", \"Cash\", \"Assets\", \"Liabilities\", \"StockholdersEquity\", \"EarningsPerShareDiluted\", \"LongTermDebt\"."New value: +"REQUIRED (alias `metric`). Metric name. Common: \"Revenue\" / \"Revenues\", \"NetIncomeLoss\", \"Cash\", \"Assets\", \"Liabilities\", \"StockholdersEquity\", \"EarningsPerShareDiluted\", \"LongTermDebt\", \"SharesOutstanding\" (newest cover-page count, dei), \"Capex\", \"OperatingCashFlow\", \"ResearchAndDevelopment\", \"SGA\", \"CostOfRevenue\", \"DilutedShares\", \"PublicFloat\". Exact us-gaap or dei tag names also work."
- Changed
entity_profile2 fields changed- added
Input schema / properties / countryAdded value: +{ + "description": "OPTIONAL ISO 3166-1 alpha-2 of the business register you mean (\"NO\", \"FI\", \"GB\", \"JP\", \"FR\", \"EE\", \"BR\"). Only affects a NAME lookup, and is often what separates the company you mean from a US namesake. When a name resolves to a register entity with no CIK, the SEC/CIK-keyed sections are reported under `sources_skipped` with reason `not_queried` — they were never asked, which is not the same as having failed.", + "type": "string" +} - changed
Input schema / properties / value / descriptionPrevious value: -"Ticker (e.g., \"AAPL\"), zero-padded CIK (e.g., \"0000320193\"), or company name (e.g., \"Moderna\") — names resolve via SEC EDGAR company-name match."New value: +"Ticker (e.g., \"AAPL\"), zero-padded CIK (e.g., \"0000320193\"), or company name (e.g., \"Moderna\"). A NAME now resolves through the national business registers as well as SEC EDGAR, so a non-US company returns its register identity and record rather than `resolved: false`."
- Changed
resolve_entity2 fields changed- added
Input schema / properties / countryAdded value: +{ + "description": "OPTIONAL ISO 3166-1 alpha-2 of the country whose business register you mean (\"NO\", \"FI\", \"JP\", \"GB\", \"FR\", \"EE\", \"BR\"). Narrows the national-register fan-out and is often the difference between the right company and a US namesake — \"Apple\" with country \"NO\" is a Norwegian company, not Apple Inc. Omitting it searches every register we can name, which is the right default when you do not know. company only; ignored for drug.", + "type": "string" +} - changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "brand": { + "type": "string" + }, + "candidates": { + "description": "Rivals, best first. Populated on \"ambiguous\" and on \"matched\" alike.", + "items": { + "properties": { + "country": { + "description": "ISO-2 of the REGISTER, not of the company's operations.", + "type": "string" + }, + "data_as_of": { + "description": "That register's own snapshot date, per row, so a stale country is visible.", + "type": [ + "string", + "null" + ] + }, + "detail_tool": { + "description": "The live pack tool that returns the full record, e.g. \"brreg-no:get_entity\".", + "type": [ + "string", + "null" + ] + }, + "legal_form": { + "type": [ + "string", + "null" + ] + }, + "legal_name": { + "type": "string" + }, + "lei": { + "description": "From the GLEIF crosswalk when present. Never guessed from a name.", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "enum": [ + "id", + "exact", + "exact_form", + "prefix", + "tokens" + ], + "type": "string" + }, + "matched_kind": { + "enum": [ + "legal", + "trading", + "former", + "english", + "kana" + ], + "type": "string" + }, + "matched_name": { + "description": "The name row that matched, exactly as the publisher spells it.", + "type": "string" + }, + "register": { + "description": "Publisher + dataset, e.g. \"Brønnøysund Register Centre, Enhetsregisteret\". Never a URL or filename.", + "type": "string" + }, + "register_id": { + "description": "The native id in the register's own canonical formatting.", + "type": "string" + }, + "register_key": { + "description": "Stable machine slug for the register.", + "type": "string" + }, + "registration_status": { + "description": "GLEIF rows only: the LEI RECORD's lifecycle (ISSUED/LAPSED/RETIRED/...). A DIFFERENT fact from `status` — a lapsed LEI is unmaintained reference data about a company that may well still trade.", + "type": [ + "string", + "null" + ] + }, + "score": { + "description": "0-1, assigned centrally. An adapter never grades itself.", + "type": "number" + }, + "status": { + "description": "The COMPANY's status.", + "enum": [ + "active", + "inactive", + "dissolved", + "unknown" + ], + "type": "string" + }, + "status_raw": { + "description": "The register's own status word, verbatim and unglossed.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "country", + "register", + "register_key", + "register_id", + "legal_name", + "score", + "status" + ], + "type": "object" + }, + "type": "array" + }, + "cik_withheld": { + "description": "A CIK that came back from a FUZZY SEC name match and is NOT asserted, because the spine matched a stronger non-US candidate. The number is here so a caller who wanted the US filer can still use it; what changed is that we no longer claim it IS the answer. See `unresolved.cik` for the reason.", + "type": "string" + }, + "fanout_incomplete": { + "description": "Present IFF at least one register in `searched[]` carried an `error` — set even when `match_status` stayed \"ambiguous\". `withheld_match` is the candidate this call declined to ASSERT because a register was missing, carried rather than discarded so a caller who accepts the caveat can still use it.", + "properties": { + "unavailable": { + "items": { + "properties": { + "country": { + "type": "string" + }, + "error": { + "type": "string" + }, + "register": { + "type": "string" + }, + "register_key": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "withheld_match": { + "type": [ + "object", + "null" + ] + } + }, + "type": "object" + }, + "figi_withheld": { + "description": "A FIGI that matched this name in OpenFIGI (`figi_match: \"name_search\"`) and is NOT asserted, because `match_status` is \"incomplete\": a name search cannot tell a company apart from a security carrying its name, and the registers that would have settled it are the ones we could not ask. A `ticker_map` FIGI is never withheld this way — it is corroborated by the resolved ticker it came from. Carried so a caller who accepts the caveat can use it; see `unresolved.figi`, and retry, since a transiently rate-limited register completes on the next call.", + "type": "string" + }, + "ids": { + "description": "Every identifier established: cik, ticker, company_name, lei, figi, isin, cusip, register_id, register_country. A key absent here appears in `unresolved` with a reason — never silently dropped.", + "type": "object" + }, + "ingredient": { + "type": "string" + }, + "match_explanation": { + "description": "Plain words. Always present when the spine ran, and required on \"ambiguous\" and \"no_match\".", + "type": "string" + }, + "match_scoring": { + "description": "The margin rule's own inputs, so a caller can see WHY it fell where it did.", + "properties": { + "margin": { + "type": [ + "number", + "null" + ] + }, + "runner_up": { + "type": [ + "number", + "null" + ] + }, + "thresholds": { + "properties": { + "floor": { + "type": "number" + }, + "margin": { + "type": "number" + }, + "match": { + "type": "number" + } + }, + "type": "object" + }, + "top": { + "type": [ + "number", + "null" + ] + } + }, + "type": "object" + }, + "match_status": { + "description": "The headline to branch on. \"ambiguous\" is an ANSWER, not a failure: two companies matched the name equally well and both are in `candidates`. \"no_match\" means every register in `searched` was asked and none carried it. \"incomplete\" means one of them could NOT be asked (it carries an `error` in `searched[]`), so the candidate set is short by an unknown amount and no id is asserted — distinct from \"ambiguous\" because a RETRY is what resolves it, not a narrower query; `fanout_incomplete` names the unreachable registers and carries, under `withheld_match`, the candidate that would have been returned on a complete fan-out.", + "enum": [ + "matched", + "ambiguous", + "no_match", + "incomplete" + ], + "type": "string" + }, + "notes": { + "type": "string" + }, + "query": { + "type": "string" + }, + "registers": { + "description": "The matched entity as every register that carries it — the match (flagged `matched: true`) plus anything that collapsed into it. A Companies House number AND the LEI that crosswalks to it are the SAME answer, not rivals.", + "items": { + "properties": { + "country": { + "description": "ISO-2 of the REGISTER, not of the company's operations.", + "type": "string" + }, + "data_as_of": { + "description": "That register's own snapshot date, per row, so a stale country is visible.", + "type": [ + "string", + "null" + ] + }, + "detail_tool": { + "description": "The live pack tool that returns the full record, e.g. \"brreg-no:get_entity\".", + "type": [ + "string", + "null" + ] + }, + "legal_form": { + "type": [ + "string", + "null" + ] + }, + "legal_name": { + "type": "string" + }, + "lei": { + "description": "From the GLEIF crosswalk when present. Never guessed from a name.", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "enum": [ + "id", + "exact", + "exact_form", + "prefix", + "tokens" + ], + "type": "string" + }, + "matched_kind": { + "enum": [ + "legal", + "trading", + "former", + "english", + "kana" + ], + "type": "string" + }, + "matched_name": { + "description": "The name row that matched, exactly as the publisher spells it.", + "type": "string" + }, + "register": { + "description": "Publisher + dataset, e.g. \"Brønnøysund Register Centre, Enhetsregisteret\". Never a URL or filename.", + "type": "string" + }, + "register_id": { + "description": "The native id in the register's own canonical formatting.", + "type": "string" + }, + "register_key": { + "description": "Stable machine slug for the register.", + "type": "string" + }, + "registration_status": { + "description": "GLEIF rows only: the LEI RECORD's lifecycle (ISSUED/LAPSED/RETIRED/...). A DIFFERENT fact from `status` — a lapsed LEI is unmaintained reference data about a company that may well still trade.", + "type": [ + "string", + "null" + ] + }, + "score": { + "description": "0-1, assigned centrally. An adapter never grades itself.", + "type": "number" + }, + "status": { + "description": "The COMPANY's status.", + "enum": [ + "active", + "inactive", + "dissolved", + "unknown" + ], + "type": "string" + }, + "status_raw": { + "description": "The register's own status word, verbatim and unglossed.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "country", + "register", + "register_key", + "register_id", + "legal_name", + "score", + "status" + ], + "type": "object" + }, + "type": "array" + }, + "related": { + "description": "Entities that collapsed INTO the match, each carrying `collapsed_by`.", + "items": { + "properties": { + "country": { + "description": "ISO-2 of the REGISTER, not of the company's operations.", + "type": "string" + }, + "data_as_of": { + "description": "That register's own snapshot date, per row, so a stale country is visible.", + "type": [ + "string", + "null" + ] + }, + "detail_tool": { + "description": "The live pack tool that returns the full record, e.g. \"brreg-no:get_entity\".", + "type": [ + "string", + "null" + ] + }, + "legal_form": { + "type": [ + "string", + "null" + ] + }, + "legal_name": { + "type": "string" + }, + "lei": { + "description": "From the GLEIF crosswalk when present. Never guessed from a name.", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "enum": [ + "id", + "exact", + "exact_form", + "prefix", + "tokens" + ], + "type": "string" + }, + "matched_kind": { + "enum": [ + "legal", + "trading", + "former", + "english", + "kana" + ], + "type": "string" + }, + "matched_name": { + "description": "The name row that matched, exactly as the publisher spells it.", + "type": "string" + }, + "register": { + "description": "Publisher + dataset, e.g. \"Brønnøysund Register Centre, Enhetsregisteret\". Never a URL or filename.", + "type": "string" + }, + "register_id": { + "description": "The native id in the register's own canonical formatting.", + "type": "string" + }, + "register_key": { + "description": "Stable machine slug for the register.", + "type": "string" + }, + "registration_status": { + "description": "GLEIF rows only: the LEI RECORD's lifecycle (ISSUED/LAPSED/RETIRED/...). A DIFFERENT fact from `status` — a lapsed LEI is unmaintained reference data about a company that may well still trade.", + "type": [ + "string", + "null" + ] + }, + "score": { + "description": "0-1, assigned centrally. An adapter never grades itself.", + "type": "number" + }, + "status": { + "description": "The COMPANY's status.", + "enum": [ + "active", + "inactive", + "dissolved", + "unknown" + ], + "type": "string" + }, + "status_raw": { + "description": "The register's own status word, verbatim and unglossed.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "country", + "register", + "register_key", + "register_id", + "legal_name", + "score", + "status" + ], + "type": "object" + }, + "type": "array" + }, + "resolved": { + "description": "At least one identifier was established. Read `match_status` and `unresolved` for WHICH — a company can be resolved in a national register with no CIK at all.", + "type": "boolean" + }, + "resources": { + "type": "object" + }, + "searched": { + "description": "EVERY register asked, with its own as-of date and row count. A register that could not be reached carries `error` — 0 rows with an error is \"we could not ask\", 0 rows without one is \"nothing is there\", and they are different answers.", + "items": { + "properties": { + "country": { + "type": "string" + }, + "data_as_of": { + "type": [ + "string", + "null" + ] + }, + "error": { + "type": "string" + }, + "register": { + "type": "string" + }, + "register_key": { + "type": "string" + }, + "rows": { + "type": "number" + } + }, + "required": [ + "register", + "register_key", + "country", + "rows" + ], + "type": "object" + }, + "type": "array" + }, + "sec_alternatives": { + "description": "EDGAR's own discarded near-misses on a name match, surfaced instead of dropped.", + "items": { + "properties": { + "cik": { + "type": "string" + }, + "company_name": { + "type": "string" + }, + "ticker": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "sources": { + "description": "Per-identifier provenance. Every key in `ids` has a matching key here.", + "type": "object" + }, + "type": { + "type": "string" + }, + "unresolved": { + "description": "Per-identifier reason an id could NOT be established — the honest twin of `ids`.", + "type": "object" + } + }, + "required": [ + "type", + "query", + "resolved", + "ids", + "sources", + "unresolved" + ], + "type": "object" +}
- Changed
subscribe2 fields changed- changed
Input schema / properties / params / descriptionPrevious 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). form_d: {state?:\"CA\", industry?:\"Biotechnology\", min_amount?:500000, exemption?:\"06B\"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:\"\\\"semiconductor sanctions\\\"\", lang?:\"eng\", domains?:[\"reuters.com\"]} (query required). job_post: EITHER {ats:\"greenhouse\", board_token:\"acme\"} (exact board) OR {domain:\"acme.com\"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:\"form5500\", args?:{...}, fields:[\"headcount\"], schedule:\"daily\"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule \"hourly\" needs the paid tier. new_entity: {state:\"CO\", name_query?:\"dental\", entity_type?:\"limited liability\"} — state is required and must be one of FL, NY, CO, OR, CT, TX, PA. Unknown keys in form_d/news_keyword/job_post/tool_diff/new_entity params are rejected at subscribe time."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). form_d: {state?:\"CA\", industry?:\"Biotechnology\", min_amount?:500000, exemption?:\"06B\"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:\"\\\"semiconductor sanctions\\\"\", lang?:\"eng\", domains?:[\"reuters.com\"]} (query required). job_post: EITHER {ats:\"greenhouse\", board_token:\"acme\"} (exact board) OR {domain:\"acme.com\"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:\"form5500\", args?:{...}, fields:[\"headcount\"], schedule:\"daily\"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule \"hourly\" needs the paid tier. new_entity: {state:\"CO\", name_query?:\"dental\", entity_type?:\"limited liability\"} — state is required and must be one of FL, NY, CO, OR, CT, TX, PA. tech_change: {domains:[\"acme.com\",\"example.org\"], technologies?:[\"Shopify\",\"Segment\"]} — domains required (1-200), technologies optional (exact names, case-insensitive) to narrow which detected technologies alert. Unknown keys in form_d/news_keyword/job_post/tool_diff/new_entity/tech_change params are rejected at subscribe time." - changed
Input schema / properties / type / enumPrevious value: -[ - "sec_8k", - "polymarket_edge", - "fred_series", - "patent_grant", - "clinical_trial", - "form_d", - "news_keyword", - "job_post", - "tool_diff", - "new_entity" -]New value: +[ + "sec_8k", + "polymarket_edge", + "fred_series", + "patent_grant", + "clinical_trial", + "form_d", + "news_keyword", + "job_post", + "tool_diff", + "new_entity", + "tech_change" +]
2 tool updates
- Changed
edgar_company_concept1 field changed- changed
Input schema / examplesPrevious value: -[ - { - "cik": "320193", - "concept": "Revenue" - }, - { - "cik": "1652044", - "concept": "NetIncomeLoss" - }, - { - "cik": "DOV", - "concept": "NetIncomeLoss", - "fiscal_period": "FY", - "fiscal_year": "2024", - "period": "annual" - } -]New value: +[ + { + "cik": "320193", + "concept": "Revenue" + }, + { + "cik": "1652044", + "concept": "NetIncomeLoss" + }, + { + "cik": "DOV", + "concept": "NetIncomeLoss", + "fiscal_period": "FY", + "fiscal_year": "2024", + "period": "annual" + }, + { + "cik": "CAPR", + "concept": "Cash" + } +]
- Changed
subscribe2 fields changed- changed
Input schema / properties / params / descriptionPrevious 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). form_d: {state?:\"CA\", industry?:\"Biotechnology\", min_amount?:500000, exemption?:\"06B\"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:\"\\\"semiconductor sanctions\\\"\", lang?:\"eng\", domains?:[\"reuters.com\"]} (query required). job_post: EITHER {ats:\"greenhouse\", board_token:\"acme\"} (exact board) OR {domain:\"acme.com\"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:\"form5500\", args?:{...}, fields:[\"headcount\"], schedule:\"daily\"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule \"hourly\" needs the paid tier. Unknown keys in form_d/news_keyword/job_post/tool_diff params are rejected at subscribe time."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). form_d: {state?:\"CA\", industry?:\"Biotechnology\", min_amount?:500000, exemption?:\"06B\"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:\"\\\"semiconductor sanctions\\\"\", lang?:\"eng\", domains?:[\"reuters.com\"]} (query required). job_post: EITHER {ats:\"greenhouse\", board_token:\"acme\"} (exact board) OR {domain:\"acme.com\"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:\"form5500\", args?:{...}, fields:[\"headcount\"], schedule:\"daily\"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule \"hourly\" needs the paid tier. new_entity: {state:\"CO\", name_query?:\"dental\", entity_type?:\"limited liability\"} — state is required and must be one of FL, NY, CO, OR, CT, TX, PA. Unknown keys in form_d/news_keyword/job_post/tool_diff/new_entity params are rejected at subscribe time." - changed
Input schema / properties / type / enumPrevious value: -[ - "sec_8k", - "polymarket_edge", - "fred_series", - "patent_grant", - "clinical_trial", - "form_d", - "news_keyword", - "job_post", - "tool_diff" -]New value: +[ + "sec_8k", + "polymarket_edge", + "fred_series", + "patent_grant", + "clinical_trial", + "form_d", + "news_keyword", + "job_post", + "tool_diff", + "new_entity" +]
7 tool updates
- Added
archive_compare - Added
archive_evidence - Added
classify_row - Changed
edgar_filing_text1 field changed- changed
Input schema / properties / search / descriptionPrevious value: -"Find a specific fact instead of paging blind. Pass a short 2-4 word phrase likely to appear VERBATIM in the prose (\"processed approximately\", \"tests processed\", \"going concern\") rather than restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice), run BEFORE max_chars/offset windowing; returns matching passages (context + their own offset) instead of the paged `text`, ranking passages with a nearby figure first. If a multi-word phrase has no verbatim match, it falls back to the phrase's individual words and returns the passages holding the most of them (search.match_mode \"words\") — read those passages for the fact rather than treating them as confirmed. Use a returned offset with a follow-up call (no `search`) to read more surrounding text. Accepted aliases: `contains`, `find`, `phrase`."New value: +"Find a specific fact instead of paging blind. Pass a short 2-4 word phrase likely to appear VERBATIM in the prose (\"processed approximately\", \"tests processed\", \"going concern\") rather than restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice), run BEFORE max_chars/offset windowing; returns matching passages (context + their own offset) instead of the paged `text`, ranking passages with a nearby figure first. If a multi-word phrase has no verbatim match, it falls back to the phrase's individual words and returns the passages holding the most of them (search.match_mode \"words\") — read those passages for the fact rather than treating them as confirmed. Use a returned offset with a follow-up call (no `search`) to read more surrounding text. **For TWO OR MORE facts from this same filing in one call, separate phrases with `|`** (e.g. \"Signatera revenue|tests processed\") — each is searched independently and reported under `searches[]`, keyed by `phrase`, instead of the singular `search`. This is the way to answer a compound question (\"what was revenue AND test volume in the latest 10-Q\") without a second call. Note: a phrase naming a financial TOTAL (revenue, net income, EPS, assets, cash, gross/operating profit, long-term debt, stockholders equity, shares outstanding) often has NO verbatim match at all, because filers frequently state only the growth delta/percentage in prose and report the actual total exclusively in XBRL — when a phrase names one of these, the response also attaches that concept's value for THIS SAME accession under `xbrl` (sourced like edgar_company_concept, not text-matched), so you don't need a separate edgar_company_concept call just to get the number the text search alone would report as a false \"not found\". Accepted aliases: `contains`, `find`, `phrase`."
- Changed
release_calendar_markets2 fields changed- added
Output schema / properties / empty_reasonAdded value: +{ + "description": "Present ONLY on a zero-release window: \"no_releases_in_window\". The window was queried and nothing is scheduled — this is an answer, not a failure.", + "type": "string" +} - added
Output schema / properties / hintAdded value: +{ + "description": "Present ONLY on a zero-release window: what to change (usually a wider `hours`).", + "type": "string" +}
- Added
research_row - Changed
subscribe2 fields changed- changed
Input schema / properties / params / descriptionPrevious 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)."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). form_d: {state?:\"CA\", industry?:\"Biotechnology\", min_amount?:500000, exemption?:\"06B\"} (all optional — omit all to watch every new Form D nationwide). news_keyword: {query:\"\\\"semiconductor sanctions\\\"\", lang?:\"eng\", domains?:[\"reuters.com\"]} (query required). job_post: EITHER {ats:\"greenhouse\", board_token:\"acme\"} (exact board) OR {domain:\"acme.com\"} (auto-detected), plus optional title_query/location_query substrings. tool_diff: {tool:\"form5500\", args?:{...}, fields:[\"headcount\"], schedule:\"daily\"} — re-runs that tool on schedule and fires when the named fields change; tool must be read-only and not need a Pipeworx-held platform key; schedule \"hourly\" needs the paid tier. Unknown keys in form_d/news_keyword/job_post/tool_diff params are rejected at subscribe time." - changed
Input schema / properties / type / enumPrevious value: -[ - "sec_8k", - "polymarket_edge", - "fred_series", - "patent_grant", - "clinical_trial" -]New value: +[ + "sec_8k", + "polymarket_edge", + "fred_series", + "patent_grant", + "clinical_trial", + "form_d", + "news_keyword", + "job_post", + "tool_diff" +]
2 tool updates
- Changed
edgar_filing_documents1 field changed- changed
Input schema / properties / form_type / descriptionPrevious value: -"When accession is omitted, the form type of the latest filing to fetch, e.g. \"10-K\", \"10-Q\", \"8-K\", \"DEF 14A\". Omit both accession and form_type to get the single most recent filing of any type."New value: +"When accession is omitted, the form type of the latest filing to fetch, e.g. \"10-K\", \"10-Q\", \"8-K\", \"DEF 14A\" — or a `|`-separated SET (\"10-K|10-Q\") for \"the most recent of either, whichever is newer\". Omit both accession and form_type to get the single most recent filing of ANY type at all (routine 8-Ks/Form 4s/Form 144s included, not just annual/quarterly reports) — use the `|` set instead when you specifically want the newest 10-K or 10-Q."
- Changed
edgar_filing_text2 fields changed- changed
Input schema / properties / form_type / descriptionPrevious value: -"When accession is omitted, the form type of the latest filing to fetch — \"10-K\", \"10-Q\", \"8-K\", \"DEF 14A\", etc. A question asking for the \"most recent 10-K OR 10-Q\" (or otherwise not committed to one type) should OMIT this field entirely rather than guess \"10-K\" by habit — omitting form_type (along with accession) returns the single most recent filing of ANY type, and a 10-Q is very often more recent than the last 10-K since it files quarterly while the 10-K only files once a year (verified live 2026-09-25, fleet #2450: NTRA's most recent 10-Q was filed 2026-08-07, five months after its 2026-02-27 10-K — passing form_type:\"10-K\" here silently skips the newer filing and the KPI it asked about)."New value: +"When accession is omitted, the form type of the latest filing to fetch — \"10-K\", \"10-Q\", \"8-K\", \"DEF 14A\", etc. For \"the most recent 10-K OR 10-Q\" (or any \"whichever of these is newer\" question), pass a `|`-separated SET, e.g. \"10-K|10-Q\" — do NOT guess a single type (\"10-K\" by habit skips a newer 10-Q) and do NOT omit this field to get \"any type\", since a company files far more 8-Ks/Form 4s/Form 144s between annual or quarterly reports than it files the reports themselves and an empty form_type returns the single most recent filing of ANY kind (verified live 2026-09-25, fleet #2450: NTRA's single most recent SEC filing was a Form 144 insider-sale notice, filed weeks after its real 10-Q and completely unrelated to the question asked)." - changed
Input schema / properties / search / descriptionPrevious value: -"Find a specific fact instead of paging blind. This is a SUBSTRING match, not a relevance search — pass the exact 2-4 word phrase most likely to appear VERBATIM in the prose (\"tests processed\", \"processed approximately\", \"going concern\"), never a compound of every concept in the question. A phrase that ANDs several unrelated question-words together (\"oncology Signatera revenue test volume\") returns ZERO matches even in the CORRECT filing, because the filing's own sentence never contains all of those words together — verified live 2026-09-25 (fleet #2450) on a real Natera 10-Q that DOES report the exact number asked for: \"Signatera revenue\" and the 4-word compound above both found nothing, while the filing's own wording (\"processed approximately\", \"tests processed\") is what actually appears. When unsure of the filing's exact phrasing, prefer the SHORTEST distinctive 2-3 word fragment of the metric name itself (a unit, a verb+noun like \"processed approximately\") over restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice, if both are given), run BEFORE max_chars/offset windowing. Returns every matching passage (surrounding context + its own offset in the document) instead of the normal paged `text` — use the returned offsets with a follow-up call (no `search`, `offset` set to one of them) if you need more surrounding text than the passage gives. Zero matches means try again with a SHORTER, more literal phrase before concluding the filing does not disclose it — this is a real answer about wording, not a tool failure. Accepted aliases: `contains`, `find`, `phrase`."New value: +"Find a specific fact instead of paging blind. Pass a short 2-4 word phrase likely to appear VERBATIM in the prose (\"processed approximately\", \"tests processed\", \"going concern\") rather than restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice), run BEFORE max_chars/offset windowing; returns matching passages (context + their own offset) instead of the paged `text`, ranking passages with a nearby figure first. If a multi-word phrase has no verbatim match, it falls back to the phrase's individual words and returns the passages holding the most of them (search.match_mode \"words\") — read those passages for the fact rather than treating them as confirmed. Use a returned offset with a follow-up call (no `search`) to read more surrounding text. Accepted aliases: `contains`, `find`, `phrase`."
5 tool updates
- Changed
deep_research8 fields changed- added
Input schema / properties / askAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / inputAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / messageAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / promptAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / qAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / queryAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - changed
Input schema / properties / question / descriptionPrevious value: -"The research question, in natural language. Broad/multi-part is fine — decomposition is the point."New value: +"The research question, in natural language. Broad/multi-part is fine — decomposition is the point. Accepts query, q, prompt, text, input, ask, message as aliases." - added
Input schema / properties / textAdded value: +{ + "description": "Alias for question.", + "type": "string" +}
- Changed
edgar_filing_text6 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "form_type": "10-Q", - "section": "liquidity", - "ticker": "ACTU" - }, - { - "accession": "0001683168-26-003909", - "cik": "1652935", - "max_chars": 30000, - "section": "going_concern" - } -]New value: +[ + { + "form_type": "10-Q", + "section": "liquidity", + "ticker": "ACTU" + }, + { + "accession": "0001683168-26-003909", + "cik": "1652935", + "max_chars": 30000, + "section": "going_concern" + }, + { + "accession": "0001628280-26-054525", + "search": "processed approximately", + "ticker": "NTRA" + } +] - added
Input schema / properties / containsAdded value: +{ + "description": "Alias for `search`.", + "type": "string" +} - added
Input schema / properties / findAdded value: +{ + "description": "Alias for `search`.", + "type": "string" +} - changed
Input schema / properties / form_type / descriptionPrevious value: -"When accession is omitted, the form type of the latest filing to fetch — \"10-K\", \"10-Q\", \"8-K\", \"DEF 14A\", etc."New value: +"When accession is omitted, the form type of the latest filing to fetch — \"10-K\", \"10-Q\", \"8-K\", \"DEF 14A\", etc. A question asking for the \"most recent 10-K OR 10-Q\" (or otherwise not committed to one type) should OMIT this field entirely rather than guess \"10-K\" by habit — omitting form_type (along with accession) returns the single most recent filing of ANY type, and a 10-Q is very often more recent than the last 10-K since it files quarterly while the 10-K only files once a year (verified live 2026-09-25, fleet #2450: NTRA's most recent 10-Q was filed 2026-08-07, five months after its 2026-02-27 10-K — passing form_type:\"10-K\" here silently skips the newer filing and the KPI it asked about)." - added
Input schema / properties / phraseAdded value: +{ + "description": "Alias for `search`.", + "type": "string" +} - added
Input schema / properties / searchAdded value: +{ + "description": "Find a specific fact instead of paging blind. This is a SUBSTRING match, not a relevance search — pass the exact 2-4 word phrase most likely to appear VERBATIM in the prose (\"tests processed\", \"processed approximately\", \"going concern\"), never a compound of every concept in the question. A phrase that ANDs several unrelated question-words together (\"oncology Signatera revenue test volume\") returns ZERO matches even in the CORRECT filing, because the filing's own sentence never contains all of those words together — verified live 2026-09-25 (fleet #2450) on a real Natera 10-Q that DOES report the exact number asked for: \"Signatera revenue\" and the 4-word compound above both found nothing, while the filing's own wording (\"processed approximately\", \"tests processed\") is what actually appears. When unsure of the filing's exact phrasing, prefer the SHORTEST distinctive 2-3 word fragment of the metric name itself (a unit, a verb+noun like \"processed approximately\") over restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice, if both are given), run BEFORE max_chars/offset windowing. Returns every matching passage (surrounding context + its own offset in the document) instead of the normal paged `text` — use the returned offsets with a follow-up call (no `search`, `offset` set to one of them) if you need more surrounding text than the passage gives. Zero matches means try again with a SHORTER, more literal phrase before concluding the filing does not disclose it — this is a real answer about wording, not a tool failure. Accepted aliases: `contains`, `find`, `phrase`.", + "type": "string" +}
- Changed
forget4 fields changed- added
Input schema / properties / kAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - changed
Input schema / properties / key / descriptionPrevious value: -"Memory key to delete"New value: +"Memory key to delete. Accepts name, k, label as aliases." - added
Input schema / properties / labelAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - added
Input schema / properties / nameAdded value: +{ + "description": "Alias for key.", + "type": "string" +}
- Changed
recall4 fields changed- added
Input schema / properties / kAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - changed
Input schema / properties / key / descriptionPrevious value: -"Memory key to retrieve (omit to list all keys)"New value: +"Memory key to retrieve (omit to list all keys). Accepts name, k, label as aliases." - added
Input schema / properties / labelAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - added
Input schema / properties / nameAdded value: +{ + "description": "Alias for key.", + "type": "string" +}
- Changed
remember9 fields changed- added
Input schema / properties / contentAdded value: +{ + "description": "Alias for value.", + "type": "string" +} - added
Input schema / properties / dataAdded value: +{ + "description": "Alias for value.", + "type": "string" +} - added
Input schema / properties / kAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - changed
Input schema / properties / key / descriptionPrevious value: -"Memory key (e.g., \"subject_property\", \"target_ticker\", \"user_preference\")"New value: +"Memory key (e.g., \"subject_property\", \"target_ticker\", \"user_preference\"). Accepts name, k, label as aliases." - added
Input schema / properties / labelAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - added
Input schema / properties / nameAdded value: +{ + "description": "Alias for key.", + "type": "string" +} - added
Input schema / properties / textAdded value: +{ + "description": "Alias for value.", + "type": "string" +} - added
Input schema / properties / vAdded value: +{ + "description": "Alias for value.", + "type": "string" +} - changed
Input schema / properties / value / descriptionPrevious value: -"Value to store (any text — findings, addresses, preferences, notes)"New value: +"Value to store (any text — findings, addresses, preferences, notes). Accepts content, text, data, v as aliases; a non-string value is stored as JSON."
42 tool updates
- Changed
ai_visibility_check1 field changed- added
Input schema / examplesAdded value: +[ + { + "entity": "Tesla" + } +]
- Changed
ask_pipeworx3 fields changed- added
Input schema / properties / askAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / messageAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - changed
Input schema / properties / question / descriptionPrevious value: -"Your question or request in natural language. Accepts query, q, prompt, text, input as aliases."New value: +"Your question or request in natural language. Accepts query, q, prompt, text, input, ask, message as aliases."
- Changed
ask_pipeworx_beta4 fields changed- added
Input schema / examplesAdded value: +[ + { + "question": "What is the current US unemployment rate?" + } +] - added
Input schema / properties / askAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / messageAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - changed
Input schema / properties / question / descriptionPrevious value: -"Your question or request in natural language. Accepts query, q, prompt, text, input as aliases."New value: +"Your question or request in natural language. Accepts query, q, prompt, text, input, ask, message as aliases."
- Changed
ask_pipeworx_grounded4 fields changed- added
Input schema / examplesAdded value: +[ + { + "question": "What was Apple's fiscal 2023 revenue?" + } +] - added
Input schema / properties / askAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - added
Input schema / properties / messageAdded value: +{ + "description": "Alias for question.", + "type": "string" +} - changed
Input schema / properties / question / descriptionPrevious value: -"Your question in natural language. Accepts query, q, prompt, text, input as aliases."New value: +"Your question in natural language. Accepts query, q, prompt, text, input, ask, message as aliases."
- Changed
bet_research2 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "market": "will-bitcoin-reach-100k-in-july-2026" - }, - { - "market": "https://polymarket.com/event/will-bitcoin-hit-150k-by-june-30-2026" - } -]New value: +[ + { + "market": "will-kristi-noem-win-the-2028-republican-presidential-nomination" + }, + { + "market": "https://polymarket.com/event/will-kristi-noem-win-the-2028-republican-presidential-nomination" + } +] - changed
Input schema / properties / market / descriptionPrevious value: -"Polymarket slug (\"will-bitcoin-hit-150k-by-june-30-2026\"), full URL (\"https://polymarket.com/event/...\"), or question text (\"Will Bitcoin hit $150k by June 30?\")"New value: +"Polymarket slug (\"will-kristi-noem-win-the-2028-republican-presidential-nomination\"), full URL (\"https://polymarket.com/event/...\"), or question text (\"Will Bitcoin hit $150k?\"). Dated slugs stop resolving once they settle — Polymarket de-indexes resolved markets — so prefer an undated one."
- Added
company_facts - Changed
compare_entities1 field changed- added
Input schema / examplesAdded value: +[ + { + "type": "company", + "values": [ + "AAPL", + "MSFT" + ] + } +]
- Changed
deep_research1 field changed- added
Input schema / examplesAdded value: +[ + { + "depth": "quick", + "question": "What is the current US unemployment rate and how has it changed over the past year?" + } +]
- Changed
edgar_companies_by_sic3 fields changed- added
Input schema / properties / cikAdded value: +{ + "description": "Alias for `ticker_or_cik` — takes a ticker or a CIK. Declared because sibling SEC tools spell this argument differently.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `ticker_or_cik` — takes a ticker or a CIK. Declared because sibling SEC tools spell this argument differently.", + "type": "string" +} - changed
Input schema / properties / ticker_or_cik / descriptionPrevious value: -"Ticker (e.g. \"AAPL\") or CIK of a company whose SIC should be resolved first, then used to find its peers. Provide this OR sic."New value: +"Ticker (e.g. \"AAPL\") or CIK of a company whose SIC should be resolved first, then used to find its peers. Provide this OR sic. Aliases: `cik`, `ticker`."
- Changed
edgar_company_concept9 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "cik": "320193", - "concept": "Revenue" - }, - { - "cik": "1652044", - "concept": "NetIncomeLoss" - } -]New value: +[ + { + "cik": "320193", + "concept": "Revenue" + }, + { + "cik": "1652044", + "concept": "NetIncomeLoss" + }, + { + "cik": "DOV", + "concept": "NetIncomeLoss", + "fiscal_period": "FY", + "fiscal_year": "2024", + "period": "annual" + } +] - changed
Input schema / properties / cik / descriptionPrevious value: -"Ticker (e.g., \"AAPL\") or CIK number (e.g., \"320193\"). Tickers are auto-resolved."New value: +"REQUIRED (or one of its aliases `ticker` / `ticker_or_cik`). Ticker (e.g., \"AAPL\") or CIK number (e.g., \"320193\"). Tickers are auto-resolved." - changed
Input schema / properties / concept / descriptionPrevious value: -"Metric name. Common: \"Revenue\" / \"Revenues\", \"NetIncomeLoss\", \"Cash\", \"Assets\", \"Liabilities\", \"StockholdersEquity\", \"EarningsPerShareDiluted\", \"LongTermDebt\"."New value: +"REQUIRED (alias `metric`). Metric name. Common: \"Revenue\" / \"Revenues\", \"NetIncomeLoss\", \"Cash\", \"Assets\", \"Liabilities\", \"StockholdersEquity\", \"EarningsPerShareDiluted\", \"LongTermDebt\"." - added
Input schema / properties / fiscal_periodAdded value: +{ + "description": "Optional filter: return only rows for this period within the fiscal year — \"FY\" (annual), \"Q1\", \"Q2\", \"Q3\", or \"Q4\" (derived: FY minus Q1-Q3). Combine with fiscal_year for a single figure.", + "enum": [ + "FY", + "Q1", + "Q2", + "Q3", + "Q4" + ], + "type": "string" +} - added
Input schema / properties / fiscal_yearAdded value: +{ + "description": "Optional filter: return only rows for this fiscal year, e.g. \"2024\". This is the filer's OWN fiscal year label (NVDA's FY2024 ended Jan 2024), not a calendar year. Unmatched years are reported with the years that ARE available rather than as an empty result.", + "type": "string" +} - added
Input schema / properties / metricAdded value: +{ + "description": "Alias for `concept` — the word this tool's own description uses for the thing you are asking about.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `cik` — same thing, a ticker or a CIK. Declared because sibling SEC tools name this argument differently (edgar_fund_holdings uses `ticker`, edgar_company_filings uses `ticker_or_cik`) and a caller filling arguments from prose reaches for whichever it read; all three spellings work here.", + "type": "string" +} - added
Input schema / properties / ticker_or_cikAdded value: +{ + "description": "Alias for `cik` — the spelling used by edgar_company_filings, edgar_insider_transactions and edgar_product_revenue.", + "type": "string" +} - changed
Input schema / requiredPrevious value: -[ - "cik", - "concept" -]New value: +[]
- Changed
edgar_company_facts4 fields changed- changed
Input schema / properties / cik / descriptionPrevious value: -"Ticker (\"NVDA\") or CIK number (\"320193\"). Tickers are auto-resolved to CIKs internally."New value: +"REQUIRED (or one of its aliases `ticker` / `ticker_or_cik`). Ticker (\"NVDA\") or CIK number (\"320193\"). Tickers are auto-resolved to CIKs internally." - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `cik` — same thing, a ticker or a CIK. The spelling edgar_fund_holdings and edgar_ticker_to_cik use.", + "type": "string" +} - added
Input schema / properties / ticker_or_cikAdded value: +{ + "description": "Alias for `cik` — the spelling edgar_company_filings, edgar_insider_transactions and edgar_product_revenue use.", + "type": "string" +} - changed
Input schema / requiredPrevious value: -[ - "cik" -]New value: +[]
- Changed
edgar_company_filings6 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "form_type": "10-Q", - "limit": 15, - "ticker_or_cik": "AAPL" - }, - { - "limit": 20, - "ticker_or_cik": "320193" - } -]New value: +[ + { + "form_type": "10-Q", + "limit": 15, + "ticker_or_cik": "AAPL" + }, + { + "limit": 20, + "ticker_or_cik": "320193" + }, + { + "form_type": "8-K", + "ticker_or_cik": "Amyris" + } +] - added
Input schema / properties / cikAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - changed
Input schema / properties / ticker_or_cik / descriptionPrevious value: -"Ticker symbol (e.g., \"AAPL\") or CIK number (e.g., \"320193\")"New value: +"REQUIRED (or one of its aliases `cik` / `ticker`). Ticker symbol (e.g., \"AAPL\") or CIK number (e.g., \"320193\")" - changed
Input schema / requiredPrevious value: -[ - "ticker_or_cik" -]New value: +[] - added
Output schema / properties / sicAdded value: +{ + "description": "SEC Standard Industrial Classification CODE, 4 digits (e.g. \"2836\" Biological Products, \"3571\" Electronic Computers). The machine-readable twin of sic_description - branch on this, not on the prose.", + "type": "string" +}
- Added
edgar_company_snapshot - Changed
edgar_filing_documents1 field changed- added
Input schema / properties / ticker_or_cikAdded value: +{ + "description": "Alias for `ticker` / `cik` — the single-argument spelling edgar_company_filings and edgar_insider_transactions use. Takes either a ticker or a CIK.", + "type": "string" +}
- Changed
edgar_filing_text1 field changed- added
Input schema / properties / ticker_or_cikAdded value: +{ + "description": "Alias for `ticker` / `cik` — the single-argument spelling edgar_company_filings and edgar_insider_transactions use. Takes either a ticker or a CIK.", + "type": "string" +}
- Changed
edgar_fund_holdings3 fields changed- changed
Input schema / properties / ticker / descriptionPrevious value: -"ETF or mutual-fund ticker (e.g. \"ARKK\", \"SPY\", \"QQQ\"). Fund tickers, not company stock tickers."New value: +"REQUIRED (or its alias `ticker_or_cik`). ETF or mutual-fund ticker (e.g. \"ARKK\", \"SPY\", \"QQQ\"). Fund tickers, not company stock tickers." - added
Input schema / properties / ticker_or_cikAdded value: +{ + "description": "Alias for `ticker` — the spelling sibling SEC tools (edgar_company_filings, edgar_insider_transactions) use. Must still be a FUND ticker: N-PORT funds are keyed by ticker, so a bare CIK will not resolve here.", + "type": "string" +} - changed
Input schema / requiredPrevious value: -[ - "ticker" -]New value: +[]
- Changed
edgar_insider_transactions4 fields changed- added
Input schema / properties / cikAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - changed
Input schema / properties / ticker_or_cik / descriptionPrevious value: -"Ticker symbol (e.g., \"TSLA\") or CIK number (e.g., \"1318605\")"New value: +"REQUIRED (or one of its aliases `cik` / `ticker`). Ticker symbol (e.g., \"TSLA\") or CIK number (e.g., \"1318605\")" - changed
Input schema / requiredPrevious value: -[ - "ticker_or_cik" -]New value: +[]
- Changed
edgar_institutional_holdings4 fields changed- added
Input schema / properties / cikAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - changed
Input schema / properties / ticker_or_cik / descriptionPrevious value: -"The institutional manager's ticker (e.g. \"BRK-B\") or CIK (e.g. \"1067983\"). NOT the held stock — the fund/manager doing the filing."New value: +"REQUIRED (or one of its aliases `cik` / `ticker`). The institutional manager's ticker (e.g. \"BRK-B\") or CIK (e.g. \"1067983\"). NOT the held stock — the fund/manager doing the filing." - changed
Input schema / requiredPrevious value: -[ - "ticker_or_cik" -]New value: +[]
- Changed
edgar_product_revenue4 fields changed- added
Input schema / properties / cikAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - changed
Input schema / properties / ticker_or_cik / descriptionPrevious value: -"Ticker (e.g. \"MRK\") or CIK (e.g. \"310158\"). Tickers are auto-resolved."New value: +"REQUIRED (or one of its aliases `cik` / `ticker`). Ticker (e.g. \"MRK\") or CIK (e.g. \"310158\"). Tickers are auto-resolved." - changed
Input schema / requiredPrevious value: -[ - "ticker_or_cik" -]New value: +[]
- Changed
edgar_ticker_to_cik6 fields changed- added
Input schema / properties / companyAdded value: +{ + "description": "Alias for `ticker` — use it when what you have is a company NAME (\"Apple Inc.\") rather than a symbol. Same argument, same behaviour.", + "type": "string" +} - changed
Input schema / properties / ticker / descriptionPrevious value: -"Stock ticker symbol (e.g., \"AAPL\", \"MSFT\", \"TSLA\") or company name (e.g., \"Apple\", \"Microsoft\")"New value: +"REQUIRED (or one of its aliases `ticker_or_cik` / `company`). Stock ticker symbol (e.g., \"AAPL\", \"MSFT\", \"TSLA\") or company name (e.g., \"Apple\", \"Microsoft\")" - added
Input schema / properties / ticker_or_cikAdded value: +{ + "description": "Alias for `ticker` — the spelling edgar_company_filings and edgar_insider_transactions use. A ticker or company name; this tool RESOLVES to a CIK, so passing a bare CIK has nothing to look up.", + "type": "string" +} - changed
Input schema / requiredPrevious value: -[ - "ticker" -]New value: +[] - changed
Output schema / properties / ticker / descriptionPrevious value: -"Stock ticker symbol"New value: +"Stock ticker symbol; null for a filer not on SEC's current-listed list (delisted, bankrupt, never listed) resolved by name via matched_by \"edgar_entity_search\"" - changed
Output schema / properties / ticker / typePrevious value: -"string"New value: +[ + "string", + "null" +]
- Changed
entity_profile1 field changed- added
Input schema / examplesAdded value: +[ + { + "type": "company", + "value": "AAPL" + } +]
- Changed
filer_to_sponsors4 fields changed- added
Input schema / properties / cikAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - added
Input schema / properties / tickerAdded value: +{ + "description": "Alias for `ticker_or_cik` — the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.", + "type": "string" +} - changed
Input schema / properties / ticker_or_cik / descriptionPrevious value: -"The PARENT company's ticker (e.g. \"MRK\") or CIK (e.g. \"310158\"). Tickers are auto-resolved to CIKs."New value: +"REQUIRED (or one of its aliases `cik` / `ticker`). The PARENT company's ticker (e.g. \"MRK\") or CIK (e.g. \"310158\"). Tickers are auto-resolved to CIKs." - changed
Input schema / requiredPrevious value: -[ - "ticker_or_cik" -]New value: +[]
- Changed
generate_llms_txt1 field changed- added
Input schema / examplesAdded value: +[ + { + "url": "https://pipeworx.io" + } +]
- Added
kalshi_weather_edge - Changed
pipeworx_feedback1 field changed- added
Input schema / examplesAdded value: +[ + { + "message": "Fleet #2184 smoke test: verifying pipeworx_feedback example call returns non-empty.", + "type": "other" + } +]
- Changed
pipeworx_trending1 field changed- added
Input schema / examplesAdded value: +[ + { + "window": "7d" + } +]
- Changed
polymarket_arbitrage1 field changed- added
Input schema / examplesAdded value: +[ + { + "topic": "Fed rate decision" + } +]
- Changed
polymarket_edge_tracker1 field changed- added
Input schema / examplesAdded value: +[ + { + "days": 14, + "window": "1wk" + } +]
- Changed
polymarket_edges3 fields changed- added
Input schema / examplesAdded value: +[ + { + "limit": 5, + "window": "1wk" + } +] - changed
Input schema / properties / min_edge_pp / descriptionPrevious value: -"Minimum |edge| in percentage points to include (default 0.5). Edge is evaluated NET of slippage."New value: +"Minimum |edge| in percentage points to include (default 0.5). Edge is evaluated NET of slippage and Polymarket's own taker fee." - changed
Input schema / properties / slippage_pp / descriptionPrevious value: -"Assumed execution slippage in percentage points per leg (default 0.3). Subtracted from raw |edge| before ranking and Kelly sizing. Polymarket has zero trading fees as of 2024 but bid/ask + thin depth typically eats 20-50bp per trade. Bump for very thin partitions; drop to 0 if you have a smarter fill model."New value: +"Assumed execution slippage in percentage points per leg (default 0.3), for bid/ask + thin depth cost that a last-trade price does not show. Subtracted from raw |edge| before ranking and Kelly sizing, ON TOP OF Polymarket's own taker fee — which is NOT zero (rate 0.04-0.07 depending on category, read off each market's own published fee schedule; see fees_pp_applied on every row and fees.ts for the full schedule). Bump slippage for very thin partitions; drop to 0 if you have a smarter fill model — the fee still applies regardless."
- Changed
polymarket_fill_risk1 field changed- added
Input schema / examplesAdded value: +[ + { + "market": "will-the-fed-increase-interest-rates-by-25-bps-after-the-december-2026-meeting-20260729232808636", + "side": "buy_yes", + "size_usd": 1000 + } +]
- Changed
polymarket_kalshi_spread2 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "topic": "fed" - }, - { - "topic": "btc" - } -]New value: +[ + { + "topic": "fed" + }, + { + "topic": "btc" + }, + { + "topic": "bitcoin" + }, + { + "topic": "fed rate decision" + } +] - changed
Input schema / properties / topic / descriptionPrevious value: -"Pre-mapped: fed | btc | cpi | gdp | sp500 | recession | next_pope | next_uk_pm | next_israel_pm | 2028_president"New value: +"Subject to compare. Canonical keys: fed | btc | eth | cpi | gdp | sp500 | recession | next_pope | next_uk_pm | next_israel_pm | 2028_president — but aliases and keywords resolve too (\"bitcoin\", \"fed rate decision\", \"ethereum\", \"inflation\", \"s&p 500\", \"us recession\", \"next pope\", \"2028 election\"). Check resolution.topic_matched_by in the response: \"exact\"/\"alias\" is a curated pairing, \"phrase\"/\"token\" is a keyword guess."
- Changed
recent_changes1 field changed- added
Input schema / examplesAdded value: +[ + { + "since": "30d", + "type": "company", + "value": "AAPL" + } +]
- Added
release_calendar_markets - Changed
remember1 field changed- added
Input schema / examplesAdded value: +[ + { + "key": "target_ticker", + "value": "AAPL" + } +]
- Added
resolution_audit - Added
resolution_diff - Changed
resolve_entity1 field changed- added
Input schema / examplesAdded value: +[ + { + "type": "company", + "value": "AAPL" + } +]
- Changed
scan_competitor_ai_presence1 field changed- added
Input schema / examplesAdded value: +[ + { + "entities": [ + "Pipeworx", + "Zapier" + ] + } +]
- Changed
scan_dependency1 field changed- added
Input schema / examplesAdded value: +[ + { + "package": "left-pad" + } +]
- Changed
search_within1 field changed- added
Input schema / examplesAdded value: +[ + { + "query": "supply-chain risk", + "text": "Apple Inc. reported fiscal 2023 revenue of $383.285 billion, driven by strong iPhone and Services growth. Net income was $96.995 billion. The company faced supply-chain risk in China during the quarter." + } +]
- Changed
suggest_questions1 field changed- added
Input schema / examplesAdded value: +[ + { + "topic": "finance" + } +]
- Changed
validate_claim1 field changed- added
Input schema / examplesAdded value: +[ + { + "claim": "Apple's fiscal 2023 revenue was $383 billion" + } +]
1 tool update
- Changed
edgar_product_revenue2 fields changed- changed
Input schema / examplesPrevious value: -[ - { - "product_filter": "Keytruda", - "ticker_or_cik": "MRK" - } -]New value: +[ + { + "product_filter": "Keytruda", + "ticker_or_cik": "MRK" + }, + { + "product_filter": "Entresto", + "ticker_or_cik": "NVS" + } +] - changed
Input schema / properties / form_type / descriptionPrevious value: -"Filing type to read the note from (default \"10-K\"). \"10-Q\" also works for filers that disaggregate revenue quarterly."New value: +"Filing type to read the note from. Omit it to try 10-K, then 20-F, then 40-F automatically — foreign private issuers (NVS, AZN, GSK, SNY, NVO, TAK) file 20-F and Canadian MJDS filers file 40-F. \"10-Q\" also works for filers that disaggregate revenue quarterly. The form actually used comes back as `resolved_form`."
1 tool update
- Changed
entity_profile3 fields changed- changed
Input schema / properties / type / descriptionPrevious value: -"Entity type. Only \"company\" supported today; person/place coming soon."New value: +"\"company\" or \"ticker\" — both are accepted and behave identically; `value` can be a ticker, CIK, or company name either way. person/place coming soon." - changed
Input schema / properties / type / enumPrevious value: -[ - "company" -]New value: +[ + "company", + "ticker" +] - changed
Input schema / properties / value / descriptionPrevious value: -"Ticker (e.g., \"AAPL\") or zero-padded CIK (e.g., \"0000320193\"). Names not supported — use resolve_entity first if you only have a name."New value: +"Ticker (e.g., \"AAPL\"), zero-padded CIK (e.g., \"0000320193\"), or company name (e.g., \"Moderna\") — names resolve via SEC EDGAR company-name match."
Related MCP Connectors
SEC MCP — SEC EDGAR public APIs (free, no auth)
SEC XBRL MCP — wraps SEC EDGAR XBRL API (data.sec.gov)
Point-in-time SEC financials API + MCP: XBRL as first reported, EDGAR times. 100 free/day.
Federal Register MCP — US Federal Register API (free, no auth)
Related MCP Servers
- AlicenseNot gradedqualityAmaintenanceQuery SEC EDGAR filings, XBRL financials, and company data through MCP.359 npm11Apache 2.0
- FlicenseNot gradedqualityBmaintenanceMCP server for SEC EDGAR data, providing company search, financial statements, XBRL concepts/frames, filings, Form 4 insider trades, and 13F filings via User-Agent authentication.-
- AlicenseAqualityDmaintenanceAn MCP server that wraps SEC EDGAR APIs to provide company financial data, screening metrics, and disclosure signals for investment diligence, with every figure traced to its source filing.8MIT
- AlicenseAqualityCmaintenanceSEC EDGAR filing MCP for equity research agents: search 10-K/10-Q/8-K with CompanyFacts metrics, preview a free sample, and purchase full structured JSON via x402 USDC on Polygon. Public endpoint on xpay.tools.32MIT
Glama MCP Gateway
Add one secure layer between your agents and this server.