@cyanheads/secedgar-mcp-server 0.17.1 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/AGENTS.md +8 -5
  2. package/CLAUDE.md +8 -5
  3. package/README.md +2 -1
  4. package/changelog/0.18.x/0.18.0.md +16 -0
  5. package/dist/mcp-server/tools/ambiguous-matches.d.ts +20 -0
  6. package/dist/mcp-server/tools/ambiguous-matches.d.ts.map +1 -0
  7. package/dist/mcp-server/tools/ambiguous-matches.js +22 -0
  8. package/dist/mcp-server/tools/ambiguous-matches.js.map +1 -0
  9. package/dist/mcp-server/tools/definitions/company-search.tool.d.ts.map +1 -1
  10. package/dist/mcp-server/tools/definitions/company-search.tool.js +11 -6
  11. package/dist/mcp-server/tools/definitions/company-search.tool.js.map +1 -1
  12. package/dist/mcp-server/tools/definitions/compare-companies.tool.d.ts.map +1 -1
  13. package/dist/mcp-server/tools/definitions/compare-companies.tool.js +16 -9
  14. package/dist/mcp-server/tools/definitions/compare-companies.tool.js.map +1 -1
  15. package/dist/mcp-server/tools/definitions/dataframe-describe.tool.d.ts.map +1 -1
  16. package/dist/mcp-server/tools/definitions/dataframe-describe.tool.js +10 -2
  17. package/dist/mcp-server/tools/definitions/dataframe-describe.tool.js.map +1 -1
  18. package/dist/mcp-server/tools/definitions/dataframe-drop.tool.d.ts.map +1 -1
  19. package/dist/mcp-server/tools/definitions/dataframe-drop.tool.js +6 -6
  20. package/dist/mcp-server/tools/definitions/dataframe-drop.tool.js.map +1 -1
  21. package/dist/mcp-server/tools/definitions/dataframe-query.tool.d.ts.map +1 -1
  22. package/dist/mcp-server/tools/definitions/dataframe-query.tool.js +10 -10
  23. package/dist/mcp-server/tools/definitions/dataframe-query.tool.js.map +1 -1
  24. package/dist/mcp-server/tools/definitions/fetch-frames.tool.d.ts.map +1 -1
  25. package/dist/mcp-server/tools/definitions/fetch-frames.tool.js +12 -7
  26. package/dist/mcp-server/tools/definitions/fetch-frames.tool.js.map +1 -1
  27. package/dist/mcp-server/tools/definitions/find-holders.tool.d.ts.map +1 -1
  28. package/dist/mcp-server/tools/definitions/find-holders.tool.js +48 -11
  29. package/dist/mcp-server/tools/definitions/find-holders.tool.js.map +1 -1
  30. package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.d.ts.map +1 -1
  31. package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.js +13 -12
  32. package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.js.map +1 -1
  33. package/dist/mcp-server/tools/definitions/get-filing.tool.d.ts.map +1 -1
  34. package/dist/mcp-server/tools/definitions/get-filing.tool.js +16 -9
  35. package/dist/mcp-server/tools/definitions/get-filing.tool.js.map +1 -1
  36. package/dist/mcp-server/tools/definitions/get-financials.tool.d.ts.map +1 -1
  37. package/dist/mcp-server/tools/definitions/get-financials.tool.js +19 -21
  38. package/dist/mcp-server/tools/definitions/get-financials.tool.js.map +1 -1
  39. package/dist/mcp-server/tools/definitions/get-fund-holdings.tool.d.ts.map +1 -1
  40. package/dist/mcp-server/tools/definitions/get-fund-holdings.tool.js +11 -19
  41. package/dist/mcp-server/tools/definitions/get-fund-holdings.tool.js.map +1 -1
  42. package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.d.ts +10 -0
  43. package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.d.ts.map +1 -1
  44. package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.js +23 -9
  45. package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.js.map +1 -1
  46. package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.d.ts.map +1 -1
  47. package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.js +8 -14
  48. package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.js.map +1 -1
  49. package/dist/mcp-server/tools/definitions/get-material-events.tool.d.ts.map +1 -1
  50. package/dist/mcp-server/tools/definitions/get-material-events.tool.js +6 -4
  51. package/dist/mcp-server/tools/definitions/get-material-events.tool.js.map +1 -1
  52. package/dist/mcp-server/tools/definitions/get-snapshot.tool.d.ts.map +1 -1
  53. package/dist/mcp-server/tools/definitions/get-snapshot.tool.js +11 -8
  54. package/dist/mcp-server/tools/definitions/get-snapshot.tool.js.map +1 -1
  55. package/dist/mcp-server/tools/definitions/index.d.ts +337 -326
  56. package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -1
  57. package/dist/mcp-server/tools/definitions/search-concepts.tool.js +2 -2
  58. package/dist/mcp-server/tools/definitions/search-concepts.tool.js.map +1 -1
  59. package/dist/mcp-server/tools/definitions/search-filings.tool.d.ts +12 -0
  60. package/dist/mcp-server/tools/definitions/search-filings.tool.d.ts.map +1 -1
  61. package/dist/mcp-server/tools/definitions/search-filings.tool.js +33 -10
  62. package/dist/mcp-server/tools/definitions/search-filings.tool.js.map +1 -1
  63. package/dist/mcp-server/tools/escape-inline.d.ts +35 -0
  64. package/dist/mcp-server/tools/escape-inline.d.ts.map +1 -0
  65. package/dist/mcp-server/tools/escape-inline.js +51 -0
  66. package/dist/mcp-server/tools/escape-inline.js.map +1 -0
  67. package/dist/mcp-server/tools/format-usd.d.ts +22 -0
  68. package/dist/mcp-server/tools/format-usd.d.ts.map +1 -0
  69. package/dist/mcp-server/tools/format-usd.js +53 -0
  70. package/dist/mcp-server/tools/format-usd.js.map +1 -0
  71. package/dist/services/edgar/edgar-api-service.d.ts +30 -9
  72. package/dist/services/edgar/edgar-api-service.d.ts.map +1 -1
  73. package/dist/services/edgar/edgar-api-service.js +90 -30
  74. package/dist/services/edgar/edgar-api-service.js.map +1 -1
  75. package/package.json +1 -1
  76. package/server.json +3 -3
@@ -30,89 +30,49 @@ export interface ToolDefinitionOptions extends LimitClampOptions {
30
30
  * it is present, so the manifest's tool count matches the documented surface.
31
31
  */
32
32
  export declare function buildToolDefinitions(options: ToolDefinitionOptions): (import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
33
- companies: import("zod").ZodArray<import("zod").ZodString>;
34
- concepts: import("zod").ZodArray<import("zod").ZodString>;
35
- taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
36
- "ifrs-full": "ifrs-full";
37
- "us-gaap": "us-gaap";
38
- }>>;
39
- period_type: import("zod").ZodDefault<import("zod").ZodEnum<{
40
- annual: "annual";
41
- quarterly: "quarterly";
42
- }>>;
43
- periods: import("zod").ZodDefault<import("zod").ZodNumber>;
33
+ query: import("zod").ZodString;
34
+ include_filings: import("zod").ZodDefault<import("zod").ZodBoolean>;
35
+ forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
36
+ filing_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
37
+ filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
38
+ filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
44
39
  }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
45
- period_type: import("zod").ZodString;
46
- taxonomy: import("zod").ZodString;
47
- periods: import("zod").ZodArray<import("zod").ZodString>;
48
- companies: import("zod").ZodArray<import("zod").ZodObject<{
49
- input: import("zod").ZodString;
50
- cik: import("zod").ZodString;
51
- name: import("zod").ZodString;
52
- ticker: import("zod").ZodOptional<import("zod").ZodString>;
53
- }, import("zod/v4/core").$strip>>;
54
- failed_companies: import("zod").ZodArray<import("zod").ZodObject<{
55
- input: import("zod").ZodString;
56
- reason: import("zod").ZodEnum<{
57
- ambiguous: "ambiguous";
58
- no_company_facts: "no_company_facts";
59
- not_found: "not_found";
60
- }>;
61
- message: import("zod").ZodString;
62
- }, import("zod/v4/core").$strip>>;
63
- deferred_companies: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
64
- concepts: import("zod").ZodArray<import("zod").ZodObject<{
65
- concept: import("zod").ZodString;
66
- label: import("zod").ZodString;
67
- units: import("zod").ZodArray<import("zod").ZodString>;
68
- }, import("zod/v4/core").$strip>>;
69
- cells: import("zod").ZodArray<import("zod").ZodObject<{
70
- cik: import("zod").ZodString;
71
- company: import("zod").ZodString;
72
- concept: import("zod").ZodString;
73
- period: import("zod").ZodString;
74
- value: import("zod").ZodNumber;
75
- unit: import("zod").ZodString;
76
- taxonomy: import("zod").ZodString;
77
- tag: import("zod").ZodString;
78
- frame: import("zod").ZodString;
79
- period_end: import("zod").ZodString;
80
- form: import("zod").ZodString;
40
+ cik: import("zod").ZodString;
41
+ name: import("zod").ZodString;
42
+ tickers: import("zod").ZodArray<import("zod").ZodString>;
43
+ exchanges: import("zod").ZodArray<import("zod").ZodString>;
44
+ sic: import("zod").ZodString;
45
+ sic_description: import("zod").ZodString;
46
+ state_of_incorporation: import("zod").ZodOptional<import("zod").ZodString>;
47
+ fiscal_year_end: import("zod").ZodOptional<import("zod").ZodString>;
48
+ series_id: import("zod").ZodOptional<import("zod").ZodString>;
49
+ class_id: import("zod").ZodOptional<import("zod").ZodString>;
50
+ filings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
81
51
  accession_number: import("zod").ZodString;
82
- }, import("zod/v4/core").$strip>>;
83
- gaps: import("zod").ZodArray<import("zod").ZodObject<{
84
- cik: import("zod").ZodString;
85
- company: import("zod").ZodString;
86
- concept: import("zod").ZodString;
87
- tags_tried: import("zod").ZodArray<import("zod").ZodString>;
88
- }, import("zod/v4/core").$strip>>;
89
- unknown_concepts: import("zod").ZodArray<import("zod").ZodObject<{
90
- concept: import("zod").ZodString;
91
- derivation: import("zod").ZodOptional<import("zod").ZodString>;
92
- suggestions: import("zod").ZodArray<import("zod").ZodString>;
93
- }, import("zod/v4/core").$strip>>;
94
- deferred_concepts: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
95
- caveats: import("zod").ZodArray<import("zod").ZodString>;
52
+ form: import("zod").ZodString;
53
+ filing_date: import("zod").ZodString;
54
+ report_date: import("zod").ZodOptional<import("zod").ZodString>;
55
+ primary_document: import("zod").ZodString;
56
+ description: import("zod").ZodOptional<import("zod").ZodString>;
57
+ }, import("zod/v4/core").$strip>>>;
58
+ total_filings: import("zod").ZodOptional<import("zod").ZodNumber>;
59
+ history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
96
60
  dataset: import("zod").ZodOptional<import("zod").ZodObject<{
97
61
  name: import("zod").ZodString;
98
62
  row_count: import("zod").ZodNumber;
99
63
  expires_at: import("zod").ZodString;
64
+ truncated: import("zod").ZodBoolean;
100
65
  }, import("zod/v4/core").$strip>>;
101
66
  }, import("zod/v4/core").$strip>, readonly [{
102
- readonly reason: "no_companies_resolved";
103
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
104
- readonly when: "None of the company inputs read resolved to a CIK; inputs past the caps were not read and are named in deferred_companies and deferred_concepts";
105
- readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
106
- }, {
107
- readonly reason: "no_comparable_data";
67
+ readonly reason: "no_match";
108
68
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
109
- readonly when: "Companies resolved but not one of them reports any of the requested concepts for the requested period type; any company or concept inputs past the caps are named, unread, in deferred_companies and deferred_concepts";
110
- readonly recovery: "Switch period_type, or discover reported concept names with secedgar_search_concepts.";
69
+ readonly when: "No company matches the query";
70
+ readonly recovery: "SEC's ticker index reflects the filer's own submissions record, which can differ from the exchange-listed symbol. ETFs and mutual funds resolve only by ticker (e.g. \"VOO\"); operating companies also resolve by full legal name or 10-digit CIK.";
111
71
  }, {
112
- readonly reason: "unknown_concept";
72
+ readonly reason: "multiple_matches";
113
73
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
114
- readonly when: "Every requested concept is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
115
- readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
74
+ readonly when: "Query is ambiguous and matches several companies";
75
+ readonly recovery: "Specify a ticker symbol for an exact match instead of a name fragment.";
116
76
  }, {
117
77
  readonly reason: "rate_limited";
118
78
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
@@ -133,6 +93,16 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
133
93
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
134
94
  readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
135
95
  }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
96
+ name: import("zod").ZodString;
97
+ }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
98
+ name: import("zod").ZodString;
99
+ dropped: import("zod").ZodBoolean;
100
+ }, import("zod/v4/core").$strip>, readonly [{
101
+ readonly reason: "canvas_unavailable";
102
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
103
+ readonly when: "The DataCanvas service is not configured for this deployment";
104
+ readonly recovery: "Dataframes need the DuckDB canvas. On an npm or Docker install, set CANVAS_PROVIDER_TYPE=duckdb (the default when unset) and restart the server; the MCPB bundle ships without DuckDB, so there the data tools return their results inline and stage no dataframe.";
105
+ }], undefined> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
136
106
  concept: import("zod").ZodString;
137
107
  taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
138
108
  dei: "dei";
@@ -221,221 +191,6 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
221
191
  readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
222
192
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
223
193
  readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
224
- }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
225
- query: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
226
- forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
227
- filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
228
- filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
229
- limit: import("zod").ZodDefault<import("zod").ZodNumber>;
230
- offset: import("zod").ZodDefault<import("zod").ZodNumber>;
231
- sort: import("zod").ZodDefault<import("zod").ZodEnum<{
232
- filing_date_asc: "filing_date_asc";
233
- filing_date_desc: "filing_date_desc";
234
- relevance: "relevance";
235
- }>>;
236
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
237
- total: import("zod").ZodNumber;
238
- total_is_exact: import("zod").ZodBoolean;
239
- total_documents: import("zod").ZodOptional<import("zod").ZodNumber>;
240
- results: import("zod").ZodArray<import("zod").ZodObject<{
241
- accession_number: import("zod").ZodString;
242
- form: import("zod").ZodOptional<import("zod").ZodString>;
243
- filing_date: import("zod").ZodString;
244
- period_ending: import("zod").ZodOptional<import("zod").ZodString>;
245
- company_name: import("zod").ZodString;
246
- cik: import("zod").ZodString;
247
- ticker: import("zod").ZodOptional<import("zod").ZodString>;
248
- file_description: import("zod").ZodOptional<import("zod").ZodString>;
249
- matched_documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
250
- name: import("zod").ZodString;
251
- type: import("zod").ZodOptional<import("zod").ZodString>;
252
- }, import("zod/v4/core").$strip>>>;
253
- sic: import("zod").ZodOptional<import("zod").ZodString>;
254
- location: import("zod").ZodOptional<import("zod").ZodString>;
255
- source: import("zod").ZodOptional<import("zod").ZodEnum<{
256
- efts: "efts";
257
- "full-index": "full-index";
258
- submissions: "submissions";
259
- }>>;
260
- }, import("zod/v4/core").$strip>>;
261
- form_distribution: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>>;
262
- scan: import("zod").ZodOptional<import("zod").ZodObject<{
263
- candidates: import("zod").ZodNumber;
264
- scanned: import("zod").ZodNumber;
265
- matched: import("zod").ZodNumber;
266
- capped: import("zod").ZodBoolean;
267
- }, import("zod/v4/core").$strip>>;
268
- dataset: import("zod").ZodOptional<import("zod").ZodObject<{
269
- name: import("zod").ZodString;
270
- row_count: import("zod").ZodNumber;
271
- expires_at: import("zod").ZodString;
272
- truncated: import("zod").ZodBoolean;
273
- }, import("zod/v4/core").$strip>>;
274
- }, import("zod/v4/core").$strip>, readonly [{
275
- readonly reason: "unresolved_ticker";
276
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
277
- readonly when: "A ticker: targeting token in the query does not resolve to a known company";
278
- readonly recovery: "Verify the symbol with secedgar_company_search, or target by CIK with cik:<number> instead.";
279
- readonly thrownBy: "service";
280
- }, {
281
- readonly reason: "invalid_cik";
282
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
283
- readonly when: "A cik: targeting token in the query is not a 1-10 digit number";
284
- readonly recovery: "Pass a numeric CIK such as cik:320193 — find it with secedgar_company_search if unknown.";
285
- readonly thrownBy: "service";
286
- }, {
287
- readonly reason: "entity_not_found";
288
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
289
- readonly when: "A cik: targeting token on a pre-2001 date range names a CIK with no EDGAR submissions history";
290
- readonly recovery: "Confirm the CIK with secedgar_company_search — an accession-number prefix names the filing agent, not the issuer.";
291
- readonly thrownBy: "service";
292
- }, {
293
- readonly reason: "missing_criteria";
294
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
295
- readonly when: "Neither a full-text query nor a forms filter was provided (a date range cannot stand alone)";
296
- readonly recovery: "Provide search terms, or browse by form type (forms: [\"S-1\"]) or entity (ticker:AAPL / cik:320193 in the query) — optionally narrowed by date.";
297
- }, {
298
- readonly reason: "pre2001_full_text_unscoped";
299
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
300
- readonly when: "A date range reaching before 2001-01-01 carries free-text terms with no entity scope — no pre-2001 full-text index exists, and nothing bounds a local scan";
301
- readonly recovery: "Add ticker: or cik: entity scope to the query, drop the text terms and browse by form type (forms: [\"10-K\"]) and date, or, for a range that reaches 2001, start the range at 2001-01-01.";
302
- }, {
303
- readonly reason: "offset_out_of_range";
304
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
305
- readonly when: "A sort=relevance search with no ticker:/cik: scope and no date range reaching before 2001 asks for an offset above 9900, past the deepest page EDGAR full-text search serves";
306
- readonly recovery: "Use an offset of 9900 or less — a page there with limit 100 reaches EDGAR's 10,000-document cap — or narrow the search with a shorter filed_after/filed_before window, a forms filter, or more specific terms so fewer documents match.";
307
- readonly retryable: false;
308
- }, {
309
- readonly reason: "rate_limited";
310
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
311
- readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
312
- readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
313
- readonly retryable: true;
314
- readonly thrownBy: "service";
315
- }, {
316
- readonly reason: "sec_unreachable";
317
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
318
- readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
319
- readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
320
- readonly retryable: true;
321
- readonly thrownBy: "service";
322
- }, {
323
- readonly reason: "efts_degraded_response";
324
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
325
- readonly when: "EDGAR full-text search answered without results — its search backend failed to run the search on every attempt made (a connection or timeout failure, retried like a request SEC never answered), refused the request (upstreamErrorType and upstreamErrorMessage carry its error, and the request is not retried), or sent a payload with no hit list";
326
- readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
327
- readonly retryable: true;
328
- readonly thrownBy: "service";
329
- }], {
330
- readonly effectiveQuery: import("zod").ZodString;
331
- readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
332
- readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
333
- readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
334
- readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
335
- }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
336
- issuer: import("zod").ZodString;
337
- form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
338
- "13D": "13D";
339
- "13G": "13G";
340
- all: "all";
341
- }>>;
342
- include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
343
- limit: import("zod").ZodDefault<import("zod").ZodNumber>;
344
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
345
- issuer: import("zod").ZodString;
346
- issuer_cik: import("zod").ZodString;
347
- issuer_name: import("zod").ZodString;
348
- form_kind: import("zod").ZodEnum<{
349
- "13D": "13D";
350
- "13G": "13G";
351
- all: "all";
352
- }>;
353
- total_structured_filings: import("zod").ZodNumber;
354
- filings_parsed: import("zod").ZodNumber;
355
- filings_examined: import("zod").ZodNumber;
356
- filings_excluded_other_issuer: import("zod").ZodNumber;
357
- filings_not_examined: import("zod").ZodNumber;
358
- filings_failed: import("zod").ZodArray<import("zod").ZodObject<{
359
- accession_number: import("zod").ZodString;
360
- reason: import("zod").ZodEnum<{
361
- document_not_found: "document_not_found";
362
- unparseable: "unparseable";
363
- }>;
364
- }, import("zod/v4/core").$strip>>;
365
- partial: import("zod").ZodBoolean;
366
- structured_coverage_from: import("zod").ZodString;
367
- legacy_filings_before_coverage: import("zod").ZodNumber;
368
- filings: import("zod").ZodArray<import("zod").ZodObject<{
369
- form: import("zod").ZodString;
370
- schedule: import("zod").ZodEnum<{
371
- "13D": "13D";
372
- "13G": "13G";
373
- }>;
374
- is_amendment: import("zod").ZodBoolean;
375
- amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
376
- accession_number: import("zod").ZodString;
377
- filing_date: import("zod").ZodString;
378
- event_date: import("zod").ZodOptional<import("zod").ZodString>;
379
- security_class: import("zod").ZodOptional<import("zod").ZodString>;
380
- cusips: import("zod").ZodArray<import("zod").ZodString>;
381
- purpose_of_transaction: import("zod").ZodOptional<import("zod").ZodString>;
382
- purpose_truncated: import("zod").ZodBoolean;
383
- reporting_persons: import("zod").ZodArray<import("zod").ZodObject<{
384
- name: import("zod").ZodString;
385
- cik: import("zod").ZodOptional<import("zod").ZodString>;
386
- citizenship: import("zod").ZodOptional<import("zod").ZodString>;
387
- percent_of_class: import("zod").ZodOptional<import("zod").ZodNumber>;
388
- aggregate_amount_owned: import("zod").ZodOptional<import("zod").ZodNumber>;
389
- sole_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
390
- shared_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
391
- sole_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
392
- shared_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
393
- person_types: import("zod").ZodArray<import("zod").ZodString>;
394
- excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
395
- notes: import("zod").ZodOptional<import("zod").ZodString>;
396
- notes_truncated: import("zod").ZodBoolean;
397
- }, import("zod/v4/core").$strip>>;
398
- }, import("zod/v4/core").$strip>>;
399
- dataset: import("zod").ZodOptional<import("zod").ZodObject<{
400
- name: import("zod").ZodString;
401
- row_count: import("zod").ZodNumber;
402
- expires_at: import("zod").ZodString;
403
- truncated: import("zod").ZodBoolean;
404
- }, import("zod/v4/core").$strip>>;
405
- }, import("zod/v4/core").$strip>, readonly [{
406
- readonly reason: "issuer_not_found";
407
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
408
- readonly when: "The issuer input does not resolve to a known EDGAR company";
409
- readonly recovery: "Use secedgar_company_search to find the issuer ticker or 10-digit CIK.";
410
- }, {
411
- readonly reason: "ambiguous_issuer";
412
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
413
- readonly when: "The issuer name matches several EDGAR companies";
414
- readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
415
- }, {
416
- readonly reason: "no_filings_found";
417
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
418
- readonly when: "The issuer has no structured SCHEDULE 13D/13G filings matching the requested form kind";
419
- readonly recovery: "Use secedgar_search_filings with forms [\"SC 13D\",\"SC 13G\"] to reach the pre-2024-12-18 text filings, then read them with secedgar_get_filing.";
420
- }, {
421
- readonly reason: "rate_limited";
422
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
423
- readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
424
- readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
425
- readonly retryable: true;
426
- readonly thrownBy: "service";
427
- }, {
428
- readonly reason: "sec_unreachable";
429
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
430
- readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
431
- readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
432
- readonly retryable: true;
433
- readonly thrownBy: "service";
434
- }], {
435
- readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
436
- readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
437
- readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
438
- readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
439
194
  }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
440
195
  company: import("zod").ZodString;
441
196
  quarter: import("zod").ZodOptional<import("zod").ZodString>;
@@ -558,33 +313,49 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
558
313
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
559
314
  readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
560
315
  }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
561
- query: import("zod").ZodString;
562
- include_filings: import("zod").ZodDefault<import("zod").ZodBoolean>;
316
+ query: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
563
317
  forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
564
- filing_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
565
318
  filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
566
319
  filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
320
+ limit: import("zod").ZodDefault<import("zod").ZodNumber>;
321
+ offset: import("zod").ZodDefault<import("zod").ZodNumber>;
322
+ sort: import("zod").ZodDefault<import("zod").ZodEnum<{
323
+ filing_date_asc: "filing_date_asc";
324
+ filing_date_desc: "filing_date_desc";
325
+ relevance: "relevance";
326
+ }>>;
567
327
  }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
568
- cik: import("zod").ZodString;
569
- name: import("zod").ZodString;
570
- tickers: import("zod").ZodArray<import("zod").ZodString>;
571
- exchanges: import("zod").ZodArray<import("zod").ZodString>;
572
- sic: import("zod").ZodString;
573
- sic_description: import("zod").ZodString;
574
- state_of_incorporation: import("zod").ZodOptional<import("zod").ZodString>;
575
- fiscal_year_end: import("zod").ZodOptional<import("zod").ZodString>;
576
- series_id: import("zod").ZodOptional<import("zod").ZodString>;
577
- class_id: import("zod").ZodOptional<import("zod").ZodString>;
578
- filings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
328
+ total: import("zod").ZodNumber;
329
+ total_is_exact: import("zod").ZodBoolean;
330
+ total_documents: import("zod").ZodOptional<import("zod").ZodNumber>;
331
+ results: import("zod").ZodArray<import("zod").ZodObject<{
579
332
  accession_number: import("zod").ZodString;
580
- form: import("zod").ZodString;
333
+ form: import("zod").ZodOptional<import("zod").ZodString>;
581
334
  filing_date: import("zod").ZodString;
582
- report_date: import("zod").ZodOptional<import("zod").ZodString>;
583
- primary_document: import("zod").ZodString;
584
- description: import("zod").ZodOptional<import("zod").ZodString>;
585
- }, import("zod/v4/core").$strip>>>;
586
- total_filings: import("zod").ZodOptional<import("zod").ZodNumber>;
587
- history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
335
+ period_ending: import("zod").ZodOptional<import("zod").ZodString>;
336
+ company_name: import("zod").ZodString;
337
+ cik: import("zod").ZodString;
338
+ ticker: import("zod").ZodOptional<import("zod").ZodString>;
339
+ file_description: import("zod").ZodOptional<import("zod").ZodString>;
340
+ matched_documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
341
+ name: import("zod").ZodString;
342
+ type: import("zod").ZodOptional<import("zod").ZodString>;
343
+ }, import("zod/v4/core").$strip>>>;
344
+ sic: import("zod").ZodOptional<import("zod").ZodString>;
345
+ location: import("zod").ZodOptional<import("zod").ZodString>;
346
+ source: import("zod").ZodOptional<import("zod").ZodEnum<{
347
+ efts: "efts";
348
+ "full-index": "full-index";
349
+ submissions: "submissions";
350
+ }>>;
351
+ }, import("zod/v4/core").$strip>>;
352
+ form_distribution: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>>;
353
+ scan: import("zod").ZodOptional<import("zod").ZodObject<{
354
+ candidates: import("zod").ZodNumber;
355
+ scanned: import("zod").ZodNumber;
356
+ matched: import("zod").ZodNumber;
357
+ capped: import("zod").ZodBoolean;
358
+ }, import("zod/v4/core").$strip>>;
588
359
  dataset: import("zod").ZodOptional<import("zod").ZodObject<{
589
360
  name: import("zod").ZodString;
590
361
  row_count: import("zod").ZodNumber;
@@ -592,15 +363,45 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
592
363
  truncated: import("zod").ZodBoolean;
593
364
  }, import("zod/v4/core").$strip>>;
594
365
  }, import("zod/v4/core").$strip>, readonly [{
595
- readonly reason: "no_match";
596
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
597
- readonly when: "No company matches the query";
598
- readonly recovery: "SEC's ticker index reflects the filer's own submissions record, which can differ from the exchange-listed symbol. ETFs and mutual funds resolve only by ticker (e.g. \"VOO\"); operating companies also resolve by full legal name or 10-digit CIK.";
366
+ readonly reason: "unresolved_ticker";
367
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
368
+ readonly when: "A ticker: targeting token in the query does not resolve to a known company";
369
+ readonly recovery: "Verify the symbol with secedgar_company_search, or target by CIK with cik:<number> instead.";
370
+ readonly thrownBy: "service";
371
+ }, {
372
+ readonly reason: "ambiguous_company";
373
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
374
+ readonly when: "A ticker: targeting token in the query resolves to multiple companies and the target is ambiguous";
375
+ readonly recovery: "Use ticker: or cik: with a ticker symbol or 10-digit CIK from the matches list for an exact match.";
376
+ readonly thrownBy: "service";
377
+ }, {
378
+ readonly reason: "invalid_cik";
379
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
380
+ readonly when: "A cik: targeting token in the query is not a 1-10 digit number";
381
+ readonly recovery: "Pass a numeric CIK such as cik:320193 — find it with secedgar_company_search if unknown.";
382
+ readonly thrownBy: "service";
599
383
  }, {
600
- readonly reason: "multiple_matches";
384
+ readonly reason: "entity_not_found";
601
385
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
602
- readonly when: "Query is ambiguous and matches several companies";
603
- readonly recovery: "Specify a ticker symbol for an exact match instead of a name fragment.";
386
+ readonly when: "A cik: targeting token on a pre-2001 date range names a CIK with no EDGAR submissions history";
387
+ readonly recovery: "Confirm the CIK with secedgar_company_search — an accession-number prefix names the filing agent, not the issuer.";
388
+ readonly thrownBy: "service";
389
+ }, {
390
+ readonly reason: "missing_criteria";
391
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
392
+ readonly when: "Neither a full-text query nor a forms filter was provided (a date range cannot stand alone)";
393
+ readonly recovery: "Provide search terms, or browse by form type (forms: [\"S-1\"]) or entity (ticker:AAPL / cik:320193 in the query) — optionally narrowed by date.";
394
+ }, {
395
+ readonly reason: "pre2001_full_text_unscoped";
396
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
397
+ readonly when: "A date range reaching before 2001-01-01 carries free-text terms with no entity scope — no pre-2001 full-text index exists, and nothing bounds a local scan";
398
+ readonly recovery: "Add ticker: or cik: entity scope to the query, drop the text terms and browse by form type (forms: [\"10-K\"]) and date, or, for a range that reaches 2001, start the range at 2001-01-01.";
399
+ }, {
400
+ readonly reason: "offset_out_of_range";
401
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
402
+ readonly when: "A sort=relevance search with no ticker:/cik: scope and no date range reaching before 2001 asks for an offset above 9900, past the deepest page EDGAR full-text search serves";
403
+ readonly recovery: "Use an offset of 9900 or less — a page there with limit 100 reaches EDGAR's 10,000-document cap — or narrow the search with a shorter filed_after/filed_before window, a forms filter, or more specific terms so fewer documents match.";
404
+ readonly retryable: false;
604
405
  }, {
605
406
  readonly reason: "rate_limited";
606
407
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
@@ -615,7 +416,15 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
615
416
  readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
616
417
  readonly retryable: true;
617
418
  readonly thrownBy: "service";
419
+ }, {
420
+ readonly reason: "efts_degraded_response";
421
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
422
+ readonly when: "EDGAR full-text search answered without results — its search backend failed to run the search on every attempt made (a connection or timeout failure, retried like a request SEC never answered), refused the request (upstreamErrorType and upstreamErrorMessage carry its error, and the request is not retried), or sent a payload with no hit list";
423
+ readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
424
+ readonly retryable: true;
425
+ readonly thrownBy: "service";
618
426
  }], {
427
+ readonly effectiveQuery: import("zod").ZodString;
619
428
  readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
620
429
  readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
621
430
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
@@ -1025,6 +834,11 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
1025
834
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
1026
835
  readonly when: "The company input does not resolve to a known company";
1027
836
  readonly recovery: "Use secedgar_company_search to find the correct ticker or CIK.";
837
+ }, {
838
+ readonly reason: "ambiguous_company";
839
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
840
+ readonly when: "The company input resolves to multiple entities and the target is ambiguous";
841
+ readonly recovery: "Use a ticker symbol or 10-digit CIK from the matches list for an exact match.";
1028
842
  }, {
1029
843
  readonly reason: "no_filings_found";
1030
844
  readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
@@ -1120,6 +934,110 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
1120
934
  readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
1121
935
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
1122
936
  readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
937
+ }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
938
+ issuer: import("zod").ZodString;
939
+ form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
940
+ "13D": "13D";
941
+ "13G": "13G";
942
+ all: "all";
943
+ }>>;
944
+ include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
945
+ limit: import("zod").ZodDefault<import("zod").ZodNumber>;
946
+ }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
947
+ issuer: import("zod").ZodString;
948
+ issuer_cik: import("zod").ZodString;
949
+ issuer_name: import("zod").ZodString;
950
+ form_kind: import("zod").ZodEnum<{
951
+ "13D": "13D";
952
+ "13G": "13G";
953
+ all: "all";
954
+ }>;
955
+ total_structured_filings: import("zod").ZodNumber;
956
+ filings_parsed: import("zod").ZodNumber;
957
+ filings_examined: import("zod").ZodNumber;
958
+ filings_excluded_other_issuer: import("zod").ZodNumber;
959
+ filings_not_examined: import("zod").ZodNumber;
960
+ filings_failed: import("zod").ZodArray<import("zod").ZodObject<{
961
+ accession_number: import("zod").ZodString;
962
+ reason: import("zod").ZodEnum<{
963
+ document_not_found: "document_not_found";
964
+ unparseable: "unparseable";
965
+ }>;
966
+ }, import("zod/v4/core").$strip>>;
967
+ partial: import("zod").ZodBoolean;
968
+ structured_coverage_from: import("zod").ZodString;
969
+ legacy_filings_before_coverage: import("zod").ZodNumber;
970
+ filings: import("zod").ZodArray<import("zod").ZodObject<{
971
+ form: import("zod").ZodString;
972
+ schedule: import("zod").ZodEnum<{
973
+ "13D": "13D";
974
+ "13G": "13G";
975
+ }>;
976
+ is_amendment: import("zod").ZodBoolean;
977
+ amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
978
+ accession_number: import("zod").ZodString;
979
+ filing_date: import("zod").ZodString;
980
+ event_date: import("zod").ZodOptional<import("zod").ZodString>;
981
+ security_class: import("zod").ZodOptional<import("zod").ZodString>;
982
+ cusips: import("zod").ZodArray<import("zod").ZodString>;
983
+ purpose_of_transaction: import("zod").ZodOptional<import("zod").ZodString>;
984
+ purpose_truncated: import("zod").ZodBoolean;
985
+ reporting_persons: import("zod").ZodArray<import("zod").ZodObject<{
986
+ name: import("zod").ZodString;
987
+ cik: import("zod").ZodOptional<import("zod").ZodString>;
988
+ citizenship: import("zod").ZodOptional<import("zod").ZodString>;
989
+ percent_of_class: import("zod").ZodOptional<import("zod").ZodNumber>;
990
+ aggregate_amount_owned: import("zod").ZodOptional<import("zod").ZodNumber>;
991
+ sole_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
992
+ shared_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
993
+ sole_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
994
+ shared_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
995
+ person_types: import("zod").ZodArray<import("zod").ZodString>;
996
+ excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
997
+ notes: import("zod").ZodOptional<import("zod").ZodString>;
998
+ notes_truncated: import("zod").ZodBoolean;
999
+ }, import("zod/v4/core").$strip>>;
1000
+ }, import("zod/v4/core").$strip>>;
1001
+ dataset: import("zod").ZodOptional<import("zod").ZodObject<{
1002
+ name: import("zod").ZodString;
1003
+ row_count: import("zod").ZodNumber;
1004
+ expires_at: import("zod").ZodString;
1005
+ truncated: import("zod").ZodBoolean;
1006
+ }, import("zod/v4/core").$strip>>;
1007
+ }, import("zod/v4/core").$strip>, readonly [{
1008
+ readonly reason: "issuer_not_found";
1009
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
1010
+ readonly when: "The issuer input does not resolve to a known EDGAR company";
1011
+ readonly recovery: "Use secedgar_company_search to find the issuer ticker or 10-digit CIK.";
1012
+ }, {
1013
+ readonly reason: "ambiguous_issuer";
1014
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
1015
+ readonly when: "The issuer name matches several EDGAR companies";
1016
+ readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
1017
+ }, {
1018
+ readonly reason: "no_filings_found";
1019
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
1020
+ readonly when: "The issuer has no structured SCHEDULE 13D/13G filings matching the requested form kind";
1021
+ readonly recovery: "Use secedgar_search_filings with forms [\"SC 13D\",\"SC 13G\"] to reach the pre-2024-12-18 text filings, then read them with secedgar_get_filing.";
1022
+ }, {
1023
+ readonly reason: "rate_limited";
1024
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
1025
+ readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
1026
+ readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
1027
+ readonly retryable: true;
1028
+ readonly thrownBy: "service";
1029
+ }, {
1030
+ readonly reason: "sec_unreachable";
1031
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
1032
+ readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
1033
+ readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
1034
+ readonly retryable: true;
1035
+ readonly thrownBy: "service";
1036
+ }], {
1037
+ readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
1038
+ readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
1039
+ readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
1040
+ readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
1123
1041
  }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
1124
1042
  fund: import("zod").ZodString;
1125
1043
  series_id: import("zod").ZodOptional<import("zod").ZodString>;
@@ -1208,6 +1126,109 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
1208
1126
  readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
1209
1127
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
1210
1128
  readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
1129
+ }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
1130
+ companies: import("zod").ZodArray<import("zod").ZodString>;
1131
+ concepts: import("zod").ZodArray<import("zod").ZodString>;
1132
+ taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
1133
+ "ifrs-full": "ifrs-full";
1134
+ "us-gaap": "us-gaap";
1135
+ }>>;
1136
+ period_type: import("zod").ZodDefault<import("zod").ZodEnum<{
1137
+ annual: "annual";
1138
+ quarterly: "quarterly";
1139
+ }>>;
1140
+ periods: import("zod").ZodDefault<import("zod").ZodNumber>;
1141
+ }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
1142
+ period_type: import("zod").ZodString;
1143
+ taxonomy: import("zod").ZodString;
1144
+ periods: import("zod").ZodArray<import("zod").ZodString>;
1145
+ companies: import("zod").ZodArray<import("zod").ZodObject<{
1146
+ input: import("zod").ZodString;
1147
+ cik: import("zod").ZodString;
1148
+ name: import("zod").ZodString;
1149
+ ticker: import("zod").ZodOptional<import("zod").ZodString>;
1150
+ }, import("zod/v4/core").$strip>>;
1151
+ failed_companies: import("zod").ZodArray<import("zod").ZodObject<{
1152
+ input: import("zod").ZodString;
1153
+ reason: import("zod").ZodEnum<{
1154
+ ambiguous: "ambiguous";
1155
+ no_company_facts: "no_company_facts";
1156
+ not_found: "not_found";
1157
+ }>;
1158
+ message: import("zod").ZodString;
1159
+ }, import("zod/v4/core").$strip>>;
1160
+ deferred_companies: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
1161
+ concepts: import("zod").ZodArray<import("zod").ZodObject<{
1162
+ concept: import("zod").ZodString;
1163
+ label: import("zod").ZodString;
1164
+ units: import("zod").ZodArray<import("zod").ZodString>;
1165
+ }, import("zod/v4/core").$strip>>;
1166
+ cells: import("zod").ZodArray<import("zod").ZodObject<{
1167
+ cik: import("zod").ZodString;
1168
+ company: import("zod").ZodString;
1169
+ concept: import("zod").ZodString;
1170
+ period: import("zod").ZodString;
1171
+ value: import("zod").ZodNumber;
1172
+ unit: import("zod").ZodString;
1173
+ taxonomy: import("zod").ZodString;
1174
+ tag: import("zod").ZodString;
1175
+ frame: import("zod").ZodString;
1176
+ period_end: import("zod").ZodString;
1177
+ form: import("zod").ZodString;
1178
+ accession_number: import("zod").ZodString;
1179
+ }, import("zod/v4/core").$strip>>;
1180
+ gaps: import("zod").ZodArray<import("zod").ZodObject<{
1181
+ cik: import("zod").ZodString;
1182
+ company: import("zod").ZodString;
1183
+ concept: import("zod").ZodString;
1184
+ tags_tried: import("zod").ZodArray<import("zod").ZodString>;
1185
+ }, import("zod/v4/core").$strip>>;
1186
+ unknown_concepts: import("zod").ZodArray<import("zod").ZodObject<{
1187
+ concept: import("zod").ZodString;
1188
+ derivation: import("zod").ZodOptional<import("zod").ZodString>;
1189
+ suggestions: import("zod").ZodArray<import("zod").ZodString>;
1190
+ }, import("zod/v4/core").$strip>>;
1191
+ deferred_concepts: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
1192
+ caveats: import("zod").ZodArray<import("zod").ZodString>;
1193
+ dataset: import("zod").ZodOptional<import("zod").ZodObject<{
1194
+ name: import("zod").ZodString;
1195
+ row_count: import("zod").ZodNumber;
1196
+ expires_at: import("zod").ZodString;
1197
+ }, import("zod/v4/core").$strip>>;
1198
+ }, import("zod/v4/core").$strip>, readonly [{
1199
+ readonly reason: "no_companies_resolved";
1200
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
1201
+ readonly when: "None of the company inputs read resolved to a CIK; inputs past the caps were not read and are named in deferred_companies and deferred_concepts";
1202
+ readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
1203
+ }, {
1204
+ readonly reason: "no_comparable_data";
1205
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
1206
+ readonly when: "Companies resolved but not one of them reports any of the requested concepts for the requested period type; any company or concept inputs past the caps are named, unread, in deferred_companies and deferred_concepts";
1207
+ readonly recovery: "Switch period_type, or discover reported concept names with secedgar_search_concepts.";
1208
+ }, {
1209
+ readonly reason: "unknown_concept";
1210
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
1211
+ readonly when: "Every requested concept is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
1212
+ readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
1213
+ }, {
1214
+ readonly reason: "rate_limited";
1215
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
1216
+ readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
1217
+ readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
1218
+ readonly retryable: true;
1219
+ readonly thrownBy: "service";
1220
+ }, {
1221
+ readonly reason: "sec_unreachable";
1222
+ readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
1223
+ readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
1224
+ readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
1225
+ readonly retryable: true;
1226
+ readonly thrownBy: "service";
1227
+ }], {
1228
+ readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
1229
+ readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
1230
+ readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
1231
+ readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
1211
1232
  }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
1212
1233
  search: import("zod").ZodOptional<import("zod").ZodString>;
1213
1234
  group: import("zod").ZodOptional<import("zod").ZodEnum<{
@@ -1354,15 +1375,5 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
1354
1375
  readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
1355
1376
  readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
1356
1377
  readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
1357
- }> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
1358
- name: import("zod").ZodString;
1359
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
1360
- name: import("zod").ZodString;
1361
- dropped: import("zod").ZodBoolean;
1362
- }, import("zod/v4/core").$strip>, readonly [{
1363
- readonly reason: "canvas_unavailable";
1364
- readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
1365
- readonly when: "The DataCanvas service is not configured for this deployment";
1366
- readonly recovery: "Dataframes need the DuckDB canvas. On an npm or Docker install, set CANVAS_PROVIDER_TYPE=duckdb (the default when unset) and restart the server; the MCPB bundle ships without DuckDB, so there the data tools return their results inline and stage no dataframe.";
1367
- }], undefined>)[];
1378
+ }>)[];
1368
1379
  //# sourceMappingURL=index.d.ts.map