@cyanheads/secedgar-mcp-server 0.17.0 → 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.
- package/AGENTS.md +22 -16
- package/CLAUDE.md +22 -16
- package/README.md +14 -10
- package/changelog/0.17.x/0.17.1.md +36 -0
- package/changelog/0.18.x/0.18.0.md +16 -0
- package/dist/config/server-config.js +1 -1
- package/dist/config/server-config.js.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/tools/ambiguous-matches.d.ts +20 -0
- package/dist/mcp-server/tools/ambiguous-matches.d.ts.map +1 -0
- package/dist/mcp-server/tools/ambiguous-matches.js +22 -0
- package/dist/mcp-server/tools/ambiguous-matches.js.map +1 -0
- package/dist/mcp-server/tools/definitions/company-search.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/company-search.tool.js +15 -8
- package/dist/mcp-server/tools/definitions/company-search.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/compare-companies.tool.d.ts +8 -4
- package/dist/mcp-server/tools/definitions/compare-companies.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/compare-companies.tool.js +182 -45
- package/dist/mcp-server/tools/definitions/compare-companies.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-describe.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-describe.tool.js +10 -2
- package/dist/mcp-server/tools/definitions/dataframe-describe.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-drop.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-drop.tool.js +6 -6
- package/dist/mcp-server/tools/definitions/dataframe-drop.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.js +10 -10
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.d.ts +4 -4
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.js +36 -15
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/find-holders.tool.d.ts +14 -0
- package/dist/mcp-server/tools/definitions/find-holders.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/find-holders.tool.js +80 -16
- package/dist/mcp-server/tools/definitions/find-holders.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.d.ts +2 -0
- package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.js +147 -77
- package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-filing.tool.d.ts +4 -4
- package/dist/mcp-server/tools/definitions/get-filing.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-filing.tool.js +321 -90
- package/dist/mcp-server/tools/definitions/get-filing.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-financials.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-financials.tool.js +19 -21
- package/dist/mcp-server/tools/definitions/get-financials.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-fund-holdings.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-fund-holdings.tool.js +11 -19
- package/dist/mcp-server/tools/definitions/get-fund-holdings.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.d.ts +10 -0
- package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.js +23 -9
- package/dist/mcp-server/tools/definitions/get-insider-transactions.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.d.ts +14 -0
- package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.js +16 -14
- package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-material-events.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-material-events.tool.js +9 -5
- package/dist/mcp-server/tools/definitions/get-material-events.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-snapshot.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-snapshot.tool.js +11 -8
- package/dist/mcp-server/tools/definitions/get-snapshot.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/index.d.ts +635 -594
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-concepts.tool.js +2 -2
- package/dist/mcp-server/tools/definitions/search-concepts.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/search-filings.tool.d.ts +45 -0
- package/dist/mcp-server/tools/definitions/search-filings.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-filings.tool.js +64 -12
- package/dist/mcp-server/tools/definitions/search-filings.tool.js.map +1 -1
- package/dist/mcp-server/tools/escape-inline.d.ts +35 -0
- package/dist/mcp-server/tools/escape-inline.d.ts.map +1 -0
- package/dist/mcp-server/tools/escape-inline.js +51 -0
- package/dist/mcp-server/tools/escape-inline.js.map +1 -0
- package/dist/mcp-server/tools/format-usd.d.ts +22 -0
- package/dist/mcp-server/tools/format-usd.d.ts.map +1 -0
- package/dist/mcp-server/tools/format-usd.js +53 -0
- package/dist/mcp-server/tools/format-usd.js.map +1 -0
- package/dist/mcp-server/tools/limit-clamp.d.ts +50 -18
- package/dist/mcp-server/tools/limit-clamp.d.ts.map +1 -1
- package/dist/mcp-server/tools/limit-clamp.js +51 -15
- package/dist/mcp-server/tools/limit-clamp.js.map +1 -1
- package/dist/services/edgar/edgar-api-service.d.ts +96 -11
- package/dist/services/edgar/edgar-api-service.d.ts.map +1 -1
- package/dist/services/edgar/edgar-api-service.js +333 -50
- package/dist/services/edgar/edgar-api-service.js.map +1 -1
- package/dist/services/edgar/filing-to-text.d.ts +4 -3
- package/dist/services/edgar/filing-to-text.d.ts.map +1 -1
- package/dist/services/edgar/filing-to-text.js +12 -0
- package/dist/services/edgar/filing-to-text.js.map +1 -1
- package/package.json +4 -4
- package/server.json +3 -3
- package/skills/secedgar-guide/SKILL.md +1 -0
|
@@ -30,87 +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
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
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
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
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
|
-
concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
64
|
-
concept: import("zod").ZodString;
|
|
65
|
-
label: import("zod").ZodString;
|
|
66
|
-
units: import("zod").ZodArray<import("zod").ZodString>;
|
|
67
|
-
}, import("zod/v4/core").$strip>>;
|
|
68
|
-
cells: import("zod").ZodArray<import("zod").ZodObject<{
|
|
69
|
-
cik: import("zod").ZodString;
|
|
70
|
-
company: import("zod").ZodString;
|
|
71
|
-
concept: import("zod").ZodString;
|
|
72
|
-
period: import("zod").ZodString;
|
|
73
|
-
value: import("zod").ZodNumber;
|
|
74
|
-
unit: import("zod").ZodString;
|
|
75
|
-
taxonomy: import("zod").ZodString;
|
|
76
|
-
tag: import("zod").ZodString;
|
|
77
|
-
frame: import("zod").ZodString;
|
|
78
|
-
period_end: import("zod").ZodString;
|
|
79
|
-
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<{
|
|
80
51
|
accession_number: import("zod").ZodString;
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
concept: import("zod").ZodString;
|
|
90
|
-
derivation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
91
|
-
suggestions: import("zod").ZodArray<import("zod").ZodString>;
|
|
92
|
-
}, import("zod/v4/core").$strip>>;
|
|
93
|
-
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>;
|
|
94
60
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
95
61
|
name: import("zod").ZodString;
|
|
96
62
|
row_count: import("zod").ZodNumber;
|
|
97
63
|
expires_at: import("zod").ZodString;
|
|
64
|
+
truncated: import("zod").ZodBoolean;
|
|
98
65
|
}, import("zod/v4/core").$strip>>;
|
|
99
66
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
100
|
-
readonly reason: "
|
|
101
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
102
|
-
readonly when: "None of the supplied company inputs resolved to a CIK";
|
|
103
|
-
readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
|
|
104
|
-
}, {
|
|
105
|
-
readonly reason: "no_comparable_data";
|
|
67
|
+
readonly reason: "no_match";
|
|
106
68
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
107
|
-
readonly when: "
|
|
108
|
-
readonly recovery: "
|
|
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.";
|
|
109
71
|
}, {
|
|
110
|
-
readonly reason: "
|
|
72
|
+
readonly reason: "multiple_matches";
|
|
111
73
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
112
|
-
readonly when: "
|
|
113
|
-
readonly recovery: "
|
|
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.";
|
|
114
76
|
}, {
|
|
115
77
|
readonly reason: "rate_limited";
|
|
116
78
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -131,6 +93,16 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
131
93
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
132
94
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
133
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<{
|
|
134
106
|
concept: import("zod").ZodString;
|
|
135
107
|
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
136
108
|
dei: "dei";
|
|
@@ -198,8 +170,8 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
198
170
|
}, {
|
|
199
171
|
readonly reason: "no_data";
|
|
200
172
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
201
|
-
readonly when: "Concept resolves but no companies report this
|
|
202
|
-
readonly recovery: "Check duration vs instant period
|
|
173
|
+
readonly when: "Concept resolves but no companies report the tag this call read for the requested period and unit";
|
|
174
|
+
readonly recovery: "Check duration vs. instant period and the unit, then query each tag the error lists in unqueried_tags — a tag has frames only for the periods filers reported it in, so another tag the concept maps to can cover a period this one lacks.";
|
|
203
175
|
}, {
|
|
204
176
|
readonly reason: "rate_limited";
|
|
205
177
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -220,412 +192,100 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
220
192
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
221
193
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
222
194
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
"13D": "13D";
|
|
226
|
-
"13G": "13G";
|
|
227
|
-
all: "all";
|
|
228
|
-
}>>;
|
|
229
|
-
include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
195
|
+
company: import("zod").ZodString;
|
|
196
|
+
quarter: import("zod").ZodOptional<import("zod").ZodString>;
|
|
230
197
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
198
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
199
|
+
consolidate: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
231
200
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
all: "all";
|
|
239
|
-
}>;
|
|
240
|
-
total_structured_filings: import("zod").ZodNumber;
|
|
241
|
-
filings_parsed: import("zod").ZodNumber;
|
|
242
|
-
filings_examined: import("zod").ZodNumber;
|
|
243
|
-
filings_excluded_other_issuer: import("zod").ZodNumber;
|
|
244
|
-
filings_not_examined: import("zod").ZodNumber;
|
|
245
|
-
filings_failed: import("zod").ZodArray<import("zod").ZodObject<{
|
|
201
|
+
filer_name: import("zod").ZodString;
|
|
202
|
+
filer_cik: import("zod").ZodString;
|
|
203
|
+
reporting_period: import("zod").ZodOptional<import("zod").ZodString>;
|
|
204
|
+
filing_date: import("zod").ZodString;
|
|
205
|
+
accession_number: import("zod").ZodString;
|
|
206
|
+
amendments: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
246
207
|
accession_number: import("zod").ZodString;
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
208
|
+
filing_date: import("zod").ZodString;
|
|
209
|
+
applied_as: import("zod").ZodEnum<{
|
|
210
|
+
new_holdings: "new_holdings";
|
|
211
|
+
not_applied: "not_applied";
|
|
212
|
+
restatement: "restatement";
|
|
213
|
+
superseded: "superseded";
|
|
250
214
|
}>;
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
legacy_filings_before_coverage: import("zod").ZodNumber;
|
|
255
|
-
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
256
|
-
form: import("zod").ZodString;
|
|
257
|
-
schedule: import("zod").ZodEnum<{
|
|
258
|
-
"13D": "13D";
|
|
259
|
-
"13G": "13G";
|
|
215
|
+
amendment_type: import("zod").ZodEnum<{
|
|
216
|
+
"NEW HOLDINGS": "NEW HOLDINGS";
|
|
217
|
+
RESTATEMENT: "RESTATEMENT";
|
|
260
218
|
}>;
|
|
261
|
-
|
|
262
|
-
amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
|
|
219
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
263
220
|
accession_number: import("zod").ZodString;
|
|
264
221
|
filing_date: import("zod").ZodString;
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
222
|
+
applied_as: import("zod").ZodEnum<{
|
|
223
|
+
new_holdings: "new_holdings";
|
|
224
|
+
not_applied: "not_applied";
|
|
225
|
+
restatement: "restatement";
|
|
226
|
+
superseded: "superseded";
|
|
227
|
+
}>;
|
|
228
|
+
amendment_type: import("zod").ZodLiteral<"UNAVAILABLE">;
|
|
229
|
+
unavailable_reason: import("zod").ZodEnum<{
|
|
230
|
+
lookup_failed: "lookup_failed";
|
|
231
|
+
lookup_stopped: "lookup_stopped";
|
|
232
|
+
missing_header: "missing_header";
|
|
233
|
+
unreadable_header: "unreadable_header";
|
|
234
|
+
}>;
|
|
235
|
+
}, import("zod/v4/core").$strip>], "amendment_type">>>;
|
|
236
|
+
amendment_search_complete: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
237
|
+
composed_accessions: import("zod").ZodArray<import("zod").ZodString>;
|
|
238
|
+
total_holdings_in_filing: import("zod").ZodNumber;
|
|
239
|
+
total_holdings_composed: import("zod").ZodNumber;
|
|
240
|
+
total_positions: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
241
|
+
offset: import("zod").ZodNumber;
|
|
242
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
243
|
+
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
244
|
+
issuer_name: import("zod").ZodString;
|
|
245
|
+
title_of_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
246
|
+
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
247
|
+
market_value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
248
|
+
shares_or_principal_amount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
249
|
+
shares_or_principal_type: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
250
|
+
PRN: "PRN";
|
|
251
|
+
SH: "SH";
|
|
252
|
+
}>>;
|
|
253
|
+
put_call: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
254
|
+
Call: "Call";
|
|
255
|
+
Put: "Put";
|
|
256
|
+
}>>;
|
|
257
|
+
investment_discretion: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
258
|
+
DFND: "DFND";
|
|
259
|
+
OTR: "OTR";
|
|
260
|
+
SOLE: "SOLE";
|
|
261
|
+
}>>;
|
|
262
|
+
source_accession_numbers: import("zod").ZodArray<import("zod").ZodString>;
|
|
284
263
|
}, import("zod/v4/core").$strip>>;
|
|
285
264
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
286
265
|
name: import("zod").ZodString;
|
|
287
266
|
row_count: import("zod").ZodNumber;
|
|
288
267
|
expires_at: import("zod").ZodString;
|
|
289
|
-
truncated: import("zod").ZodBoolean;
|
|
290
268
|
}, import("zod/v4/core").$strip>>;
|
|
291
269
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
292
|
-
readonly reason: "
|
|
270
|
+
readonly reason: "company_not_found";
|
|
293
271
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
294
|
-
readonly when: "The
|
|
295
|
-
readonly recovery: "Use secedgar_company_search to find the
|
|
272
|
+
readonly when: "The company input does not resolve to a known company or institution";
|
|
273
|
+
readonly recovery: "Use secedgar_company_search to find the correct CIK or full entity name.";
|
|
296
274
|
}, {
|
|
297
|
-
readonly reason: "
|
|
275
|
+
readonly reason: "ambiguous_entity";
|
|
298
276
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
299
|
-
readonly when: "The
|
|
300
|
-
readonly recovery: "Retry with the
|
|
277
|
+
readonly when: "The name resolves to multiple EDGAR entities (e.g. several filers sharing a legal name)";
|
|
278
|
+
readonly recovery: "Retry with the exact 10-digit CIK of the intended filer from the matches list.";
|
|
301
279
|
}, {
|
|
302
280
|
readonly reason: "no_filings_found";
|
|
303
281
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
304
|
-
readonly when: "
|
|
305
|
-
readonly recovery: "Use secedgar_search_filings with forms
|
|
306
|
-
}, {
|
|
307
|
-
readonly reason: "
|
|
308
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
309
|
-
readonly when: "
|
|
310
|
-
readonly recovery: "
|
|
311
|
-
readonly retryable: true;
|
|
312
|
-
readonly thrownBy: "service";
|
|
313
|
-
}, {
|
|
314
|
-
readonly reason: "sec_unreachable";
|
|
315
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
316
|
-
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";
|
|
317
|
-
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.";
|
|
318
|
-
readonly retryable: true;
|
|
319
|
-
readonly thrownBy: "service";
|
|
320
|
-
}], {
|
|
321
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
322
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
323
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
324
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
325
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
326
|
-
accession_number: import("zod").ZodString;
|
|
327
|
-
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
328
|
-
content_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
329
|
-
document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
330
|
-
include_xbrl: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
331
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
332
|
-
section: import("zod").ZodOptional<import("zod").ZodString>;
|
|
333
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
334
|
-
accession_number: import("zod").ZodString;
|
|
335
|
-
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
336
|
-
filing_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
337
|
-
company_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
338
|
-
cik: import("zod").ZodString;
|
|
339
|
-
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
340
|
-
primary_document: import("zod").ZodString;
|
|
341
|
-
requested_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
342
|
-
documents: import("zod").ZodObject<{
|
|
343
|
-
primary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
344
|
-
name: import("zod").ZodString;
|
|
345
|
-
type: import("zod").ZodString;
|
|
346
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
347
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
348
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
349
|
-
}, import("zod/v4/core").$strip>>;
|
|
350
|
-
exhibits: import("zod").ZodArray<import("zod").ZodObject<{
|
|
351
|
-
name: import("zod").ZodString;
|
|
352
|
-
type: import("zod").ZodString;
|
|
353
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
354
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
355
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
356
|
-
}, import("zod/v4/core").$strip>>;
|
|
357
|
-
auxiliary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
358
|
-
name: import("zod").ZodString;
|
|
359
|
-
type: import("zod").ZodString;
|
|
360
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
361
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
362
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
363
|
-
}, import("zod/v4/core").$strip>>;
|
|
364
|
-
xbrl: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
365
|
-
name: import("zod").ZodString;
|
|
366
|
-
type: import("zod").ZodString;
|
|
367
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
368
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
369
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
370
|
-
}, import("zod/v4/core").$strip>>>;
|
|
371
|
-
}, import("zod/v4/core").$strip>;
|
|
372
|
-
content: import("zod").ZodString;
|
|
373
|
-
content_truncated: import("zod").ZodBoolean;
|
|
374
|
-
content_total_length: import("zod").ZodNumber;
|
|
375
|
-
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
376
|
-
outline: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
377
|
-
heading: import("zod").ZodString;
|
|
378
|
-
offset: import("zod").ZodNumber;
|
|
379
|
-
}, import("zod/v4/core").$strip>>>;
|
|
380
|
-
filing_url: import("zod").ZodString;
|
|
381
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
382
|
-
readonly reason: "document_not_found";
|
|
383
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
384
|
-
readonly when: "A specific document was requested but not present in the filing archive";
|
|
385
|
-
readonly recovery: "Pick a filename from the categorized document list in the error message.";
|
|
386
|
-
}, {
|
|
387
|
-
readonly reason: "no_documents";
|
|
388
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
389
|
-
readonly when: "Filing index lists items but no fetchable primary document was found";
|
|
390
|
-
readonly recovery: "Set document to one of the filenames listed in the error message.";
|
|
391
|
-
}, {
|
|
392
|
-
readonly reason: "binary_document";
|
|
393
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
394
|
-
readonly when: "The requested document is a binary entry (scanned image, PDF, archive) with no text to return";
|
|
395
|
-
readonly recovery: "Pick a text document (.htm, .txt, .xml) from the list in the error message.";
|
|
396
|
-
}, {
|
|
397
|
-
readonly reason: "filing_not_found";
|
|
398
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
399
|
-
readonly when: "No filing matches the accession number under any candidate CIK";
|
|
400
|
-
readonly recovery: "Verify the accession number and pass the company CIK explicitly.";
|
|
401
|
-
}, {
|
|
402
|
-
readonly reason: "offset_out_of_range";
|
|
403
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
404
|
-
readonly when: "The provided offset is at or beyond the end of the document";
|
|
405
|
-
readonly recovery: "Use an offset less than the total document length shown in the error message.";
|
|
406
|
-
}, {
|
|
407
|
-
readonly reason: "section_not_found";
|
|
408
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
409
|
-
readonly when: "The section string matched no detected heading and no line of the document";
|
|
410
|
-
readonly recovery: "Pick a heading from the outline in the error message, pass a subheading exactly as the document prints it, or use offset paging instead.";
|
|
411
|
-
}, {
|
|
412
|
-
readonly reason: "rate_limited";
|
|
413
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
414
|
-
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";
|
|
415
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
416
|
-
readonly retryable: true;
|
|
417
|
-
readonly thrownBy: "service";
|
|
418
|
-
}, {
|
|
419
|
-
readonly reason: "sec_unreachable";
|
|
420
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
421
|
-
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";
|
|
422
|
-
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.";
|
|
423
|
-
readonly retryable: true;
|
|
424
|
-
readonly thrownBy: "service";
|
|
425
|
-
}], {
|
|
426
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
427
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
428
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
429
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
430
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
431
|
-
fund: import("zod").ZodString;
|
|
432
|
-
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
433
|
-
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
434
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
435
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
436
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
437
|
-
fund: import("zod").ZodString;
|
|
438
|
-
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
439
|
-
series_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
440
|
-
class_ids: import("zod").ZodArray<import("zod").ZodString>;
|
|
441
|
-
registrant_cik: import("zod").ZodString;
|
|
442
|
-
registrant_name: import("zod").ZodString;
|
|
443
|
-
report_period_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
444
|
-
report_period_end: import("zod").ZodOptional<import("zod").ZodString>;
|
|
445
|
-
filing_date: import("zod").ZodString;
|
|
446
|
-
publication_lag_days: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
447
|
-
form: import("zod").ZodString;
|
|
448
|
-
accession_number: import("zod").ZodString;
|
|
449
|
-
is_final_filing: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
450
|
-
net_assets_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
451
|
-
total_assets_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
452
|
-
total_liabilities_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
453
|
-
total_holdings: import("zod").ZodNumber;
|
|
454
|
-
offset: import("zod").ZodNumber;
|
|
455
|
-
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
456
|
-
available_report_periods: import("zod").ZodArray<import("zod").ZodString>;
|
|
457
|
-
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
458
|
-
name: import("zod").ZodString;
|
|
459
|
-
title: import("zod").ZodOptional<import("zod").ZodString>;
|
|
460
|
-
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
461
|
-
isin: import("zod").ZodOptional<import("zod").ZodString>;
|
|
462
|
-
lei: import("zod").ZodOptional<import("zod").ZodString>;
|
|
463
|
-
balance: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
464
|
-
units: import("zod").ZodOptional<import("zod").ZodString>;
|
|
465
|
-
currency: import("zod").ZodOptional<import("zod").ZodString>;
|
|
466
|
-
value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
467
|
-
percent_of_net_assets: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
468
|
-
payoff_profile: import("zod").ZodOptional<import("zod").ZodString>;
|
|
469
|
-
asset_category: import("zod").ZodOptional<import("zod").ZodString>;
|
|
470
|
-
issuer_category: import("zod").ZodOptional<import("zod").ZodString>;
|
|
471
|
-
country: import("zod").ZodOptional<import("zod").ZodString>;
|
|
472
|
-
}, import("zod/v4/core").$strip>>;
|
|
473
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
474
|
-
name: import("zod").ZodString;
|
|
475
|
-
row_count: import("zod").ZodNumber;
|
|
476
|
-
expires_at: import("zod").ZodString;
|
|
477
|
-
}, import("zod/v4/core").$strip>>;
|
|
478
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
479
|
-
readonly reason: "fund_not_found";
|
|
480
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
481
|
-
readonly when: "The fund input resolves to neither an EDGAR company nor a known fund series";
|
|
482
|
-
readonly recovery: "Use secedgar_company_search with the fund ticker to get its CIK and series ID.";
|
|
483
|
-
}, {
|
|
484
|
-
readonly reason: "ambiguous_fund";
|
|
485
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
486
|
-
readonly when: "The fund name matches several EDGAR companies";
|
|
487
|
-
readonly recovery: "Retry with the fund ticker or the 10-digit CIK from the matches list.";
|
|
488
|
-
}, {
|
|
489
|
-
readonly reason: "series_required";
|
|
490
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
491
|
-
readonly when: "The input resolves to a registrant trust that files reports for more than one fund series";
|
|
492
|
-
readonly recovery: "Retry with series_id set to one of the listed series, or pass a fund ticker.";
|
|
493
|
-
}, {
|
|
494
|
-
readonly reason: "no_filings_found";
|
|
495
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
496
|
-
readonly when: "No NPORT-P report exists for this fund, or none covers the report_date requested";
|
|
497
|
-
readonly recovery: "Drop report_date to take the newest report, or use secedgar_search_filings with forms [\"NPORT-P\"] to see what the registrant has filed.";
|
|
498
|
-
}, {
|
|
499
|
-
readonly reason: "rate_limited";
|
|
500
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
501
|
-
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";
|
|
502
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
503
|
-
readonly retryable: true;
|
|
504
|
-
readonly thrownBy: "service";
|
|
505
|
-
}, {
|
|
506
|
-
readonly reason: "sec_unreachable";
|
|
507
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
508
|
-
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";
|
|
509
|
-
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.";
|
|
510
|
-
readonly retryable: true;
|
|
511
|
-
readonly thrownBy: "service";
|
|
512
|
-
}], {
|
|
513
|
-
readonly as_of: import("zod").ZodString;
|
|
514
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
515
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
516
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
517
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
518
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
519
|
-
company: import("zod").ZodString;
|
|
520
|
-
items: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodEnum<{
|
|
521
|
-
[x: string]: string;
|
|
522
|
-
}>>>;
|
|
523
|
-
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
524
|
-
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
525
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
526
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
527
|
-
cik: import("zod").ZodString;
|
|
528
|
-
company_name: import("zod").ZodString;
|
|
529
|
-
items_filter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
530
|
-
total_matched: import("zod").ZodNumber;
|
|
531
|
-
total_8k_scanned: import("zod").ZodNumber;
|
|
532
|
-
item_distribution: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>;
|
|
533
|
-
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
534
|
-
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
535
|
-
accession_number: import("zod").ZodString;
|
|
536
|
-
form: import("zod").ZodString;
|
|
537
|
-
filing_date: import("zod").ZodString;
|
|
538
|
-
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
539
|
-
primary_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
540
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
541
|
-
items: import("zod").ZodArray<import("zod").ZodObject<{
|
|
542
|
-
code: import("zod").ZodString;
|
|
543
|
-
label: import("zod").ZodOptional<import("zod").ZodString>;
|
|
544
|
-
regime: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
545
|
-
current: "current";
|
|
546
|
-
legacy: "legacy";
|
|
547
|
-
}>>;
|
|
548
|
-
}, import("zod/v4/core").$strip>>;
|
|
549
|
-
}, import("zod/v4/core").$strip>>;
|
|
550
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
551
|
-
name: import("zod").ZodString;
|
|
552
|
-
row_count: import("zod").ZodNumber;
|
|
553
|
-
expires_at: import("zod").ZodString;
|
|
554
|
-
truncated: import("zod").ZodBoolean;
|
|
555
|
-
}, import("zod/v4/core").$strip>>;
|
|
556
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
557
|
-
readonly reason: "no_match";
|
|
558
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
559
|
-
readonly when: "No company matches the query";
|
|
560
|
-
readonly recovery: "Use a ticker symbol or 10-digit CIK for an exact match, or find the company with secedgar_company_search.";
|
|
561
|
-
}, {
|
|
562
|
-
readonly reason: "multiple_matches";
|
|
563
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
564
|
-
readonly when: "The query is ambiguous and matches several companies";
|
|
565
|
-
readonly recovery: "Retry with a ticker symbol or the 10-digit CIK from the matches list.";
|
|
566
|
-
}, {
|
|
567
|
-
readonly reason: "rate_limited";
|
|
568
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
569
|
-
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";
|
|
570
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
571
|
-
readonly retryable: true;
|
|
572
|
-
readonly thrownBy: "service";
|
|
573
|
-
}, {
|
|
574
|
-
readonly reason: "sec_unreachable";
|
|
575
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
576
|
-
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";
|
|
577
|
-
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.";
|
|
578
|
-
readonly retryable: true;
|
|
579
|
-
readonly thrownBy: "service";
|
|
580
|
-
}], {
|
|
581
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
582
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
583
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
584
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
585
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
586
|
-
query: import("zod").ZodString;
|
|
587
|
-
include_filings: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
588
|
-
forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
589
|
-
filing_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
590
|
-
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
591
|
-
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
592
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
593
|
-
cik: import("zod").ZodString;
|
|
594
|
-
name: import("zod").ZodString;
|
|
595
|
-
tickers: import("zod").ZodArray<import("zod").ZodString>;
|
|
596
|
-
exchanges: import("zod").ZodArray<import("zod").ZodString>;
|
|
597
|
-
sic: import("zod").ZodString;
|
|
598
|
-
sic_description: import("zod").ZodString;
|
|
599
|
-
state_of_incorporation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
600
|
-
fiscal_year_end: import("zod").ZodOptional<import("zod").ZodString>;
|
|
601
|
-
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
602
|
-
class_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
603
|
-
filings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
604
|
-
accession_number: import("zod").ZodString;
|
|
605
|
-
form: import("zod").ZodString;
|
|
606
|
-
filing_date: import("zod").ZodString;
|
|
607
|
-
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
608
|
-
primary_document: import("zod").ZodString;
|
|
609
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
610
|
-
}, import("zod/v4/core").$strip>>>;
|
|
611
|
-
total_filings: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
612
|
-
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
613
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
614
|
-
name: import("zod").ZodString;
|
|
615
|
-
row_count: import("zod").ZodNumber;
|
|
616
|
-
expires_at: import("zod").ZodString;
|
|
617
|
-
truncated: import("zod").ZodBoolean;
|
|
618
|
-
}, import("zod/v4/core").$strip>>;
|
|
619
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
620
|
-
readonly reason: "no_match";
|
|
621
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
622
|
-
readonly when: "No company matches the query";
|
|
623
|
-
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.";
|
|
624
|
-
}, {
|
|
625
|
-
readonly reason: "multiple_matches";
|
|
626
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
627
|
-
readonly when: "Query is ambiguous and matches several companies";
|
|
628
|
-
readonly recovery: "Specify a ticker symbol for an exact match instead of a name fragment.";
|
|
282
|
+
readonly when: "No 13F-HR matches — the entity files none, none exists for the requested quarter in the recent submissions window or the archive pages searched, or the manager filed a 13F-NT notice instead (for the requested quarter, or as its only recent 13F filing when no quarter is given)";
|
|
283
|
+
readonly recovery: "Use secedgar_search_filings with forms=[\"13F-HR\"] for broader search, or check that the entity is an institutional investment manager.";
|
|
284
|
+
}, {
|
|
285
|
+
readonly reason: "no_info_table";
|
|
286
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
287
|
+
readonly when: "The 13F-HR filing was found but the information table XML document could not be located";
|
|
288
|
+
readonly recovery: "Use secedgar_get_filing with the accession number to inspect the filing documents directly.";
|
|
629
289
|
}, {
|
|
630
290
|
readonly reason: "rate_limited";
|
|
631
291
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -640,6 +300,13 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
640
300
|
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.";
|
|
641
301
|
readonly retryable: true;
|
|
642
302
|
readonly thrownBy: "service";
|
|
303
|
+
}, {
|
|
304
|
+
readonly reason: "efts_degraded_response";
|
|
305
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
306
|
+
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";
|
|
307
|
+
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
308
|
+
readonly retryable: true;
|
|
309
|
+
readonly thrownBy: "service";
|
|
643
310
|
}], {
|
|
644
311
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
645
312
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
@@ -701,6 +368,12 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
701
368
|
readonly when: "A ticker: targeting token in the query does not resolve to a known company";
|
|
702
369
|
readonly recovery: "Verify the symbol with secedgar_company_search, or target by CIK with cik:<number> instead.";
|
|
703
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";
|
|
704
377
|
}, {
|
|
705
378
|
readonly reason: "invalid_cik";
|
|
706
379
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
@@ -708,21 +381,140 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
708
381
|
readonly recovery: "Pass a numeric CIK such as cik:320193 — find it with secedgar_company_search if unknown.";
|
|
709
382
|
readonly thrownBy: "service";
|
|
710
383
|
}, {
|
|
711
|
-
readonly reason: "entity_not_found";
|
|
384
|
+
readonly reason: "entity_not_found";
|
|
385
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
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;
|
|
405
|
+
}, {
|
|
406
|
+
readonly reason: "rate_limited";
|
|
407
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
408
|
+
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";
|
|
409
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
410
|
+
readonly retryable: true;
|
|
411
|
+
readonly thrownBy: "service";
|
|
412
|
+
}, {
|
|
413
|
+
readonly reason: "sec_unreachable";
|
|
414
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
415
|
+
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";
|
|
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.";
|
|
417
|
+
readonly retryable: true;
|
|
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";
|
|
426
|
+
}], {
|
|
427
|
+
readonly effectiveQuery: import("zod").ZodString;
|
|
428
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
429
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
430
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
431
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
432
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
433
|
+
accession_number: import("zod").ZodString;
|
|
434
|
+
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
435
|
+
content_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
436
|
+
document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
437
|
+
include_xbrl: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
438
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
439
|
+
section: import("zod").ZodOptional<import("zod").ZodString>;
|
|
440
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
441
|
+
accession_number: import("zod").ZodString;
|
|
442
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
443
|
+
filing_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
444
|
+
company_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
445
|
+
cik: import("zod").ZodString;
|
|
446
|
+
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
447
|
+
primary_document: import("zod").ZodString;
|
|
448
|
+
requested_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
449
|
+
documents: import("zod").ZodObject<{
|
|
450
|
+
primary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
451
|
+
name: import("zod").ZodString;
|
|
452
|
+
type: import("zod").ZodString;
|
|
453
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
454
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
455
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
456
|
+
}, import("zod/v4/core").$strip>>;
|
|
457
|
+
exhibits: import("zod").ZodArray<import("zod").ZodObject<{
|
|
458
|
+
name: import("zod").ZodString;
|
|
459
|
+
type: import("zod").ZodString;
|
|
460
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
461
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
462
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
463
|
+
}, import("zod/v4/core").$strip>>;
|
|
464
|
+
auxiliary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
465
|
+
name: import("zod").ZodString;
|
|
466
|
+
type: import("zod").ZodString;
|
|
467
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
468
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
469
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
470
|
+
}, import("zod/v4/core").$strip>>;
|
|
471
|
+
xbrl: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
472
|
+
name: import("zod").ZodString;
|
|
473
|
+
type: import("zod").ZodString;
|
|
474
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
475
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
476
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
477
|
+
}, import("zod/v4/core").$strip>>>;
|
|
478
|
+
}, import("zod/v4/core").$strip>;
|
|
479
|
+
content: import("zod").ZodString;
|
|
480
|
+
content_truncated: import("zod").ZodBoolean;
|
|
481
|
+
content_total_length: import("zod").ZodNumber;
|
|
482
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
483
|
+
outline: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
484
|
+
heading: import("zod").ZodString;
|
|
485
|
+
offset: import("zod").ZodNumber;
|
|
486
|
+
}, import("zod/v4/core").$strip>>>;
|
|
487
|
+
filing_url: import("zod").ZodString;
|
|
488
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
489
|
+
readonly reason: "document_not_found";
|
|
490
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
491
|
+
readonly when: "A specific document was requested but not present in the filing archive";
|
|
492
|
+
readonly recovery: "Pick a filename from the categorized document list in the error message; when the archive does not serve the one requested, pass the filer's CIK as cik.";
|
|
493
|
+
}, {
|
|
494
|
+
readonly reason: "no_documents";
|
|
495
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
496
|
+
readonly when: "Filing index lists items but no fetchable primary document was found";
|
|
497
|
+
readonly recovery: "Pass the filer's CIK as cik (resolve it with secedgar_company_search), or set document to another filename listed in the error message.";
|
|
498
|
+
}, {
|
|
499
|
+
readonly reason: "binary_document";
|
|
500
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
501
|
+
readonly when: "The requested document is a binary entry (scanned image, PDF, archive) with no text to return";
|
|
502
|
+
readonly recovery: "Pick a text document (.htm, .txt, .xml) from the list in the error message.";
|
|
503
|
+
}, {
|
|
504
|
+
readonly reason: "filing_not_found";
|
|
712
505
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
713
|
-
readonly when: "
|
|
714
|
-
readonly recovery: "
|
|
715
|
-
readonly thrownBy: "service";
|
|
506
|
+
readonly when: "No filing matches the accession number under any candidate CIK";
|
|
507
|
+
readonly recovery: "Verify the accession number and pass the company CIK explicitly.";
|
|
716
508
|
}, {
|
|
717
|
-
readonly reason: "
|
|
509
|
+
readonly reason: "offset_out_of_range";
|
|
718
510
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
719
|
-
readonly when: "
|
|
720
|
-
readonly recovery: "
|
|
511
|
+
readonly when: "The provided offset is at or beyond the end of the document";
|
|
512
|
+
readonly recovery: "Use an offset less than the total document length shown in the error message.";
|
|
721
513
|
}, {
|
|
722
|
-
readonly reason: "
|
|
723
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
724
|
-
readonly when: "
|
|
725
|
-
readonly recovery: "
|
|
514
|
+
readonly reason: "section_not_found";
|
|
515
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
516
|
+
readonly when: "The section string matched no detected heading and no line of the document";
|
|
517
|
+
readonly recovery: "Pick a heading from the outline in the error message, pass a subheading exactly as the document prints it, or use offset paging instead.";
|
|
726
518
|
}, {
|
|
727
519
|
readonly reason: "rate_limited";
|
|
728
520
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -738,7 +530,6 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
738
530
|
readonly retryable: true;
|
|
739
531
|
readonly thrownBy: "service";
|
|
740
532
|
}], {
|
|
741
|
-
readonly effectiveQuery: import("zod").ZodString;
|
|
742
533
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
743
534
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
744
535
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -925,6 +716,73 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
925
716
|
readonly retryable: true;
|
|
926
717
|
readonly thrownBy: "service";
|
|
927
718
|
}], undefined> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
719
|
+
company: import("zod").ZodString;
|
|
720
|
+
items: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodEnum<{
|
|
721
|
+
[x: string]: string;
|
|
722
|
+
}>>>;
|
|
723
|
+
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
724
|
+
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
725
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
726
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
727
|
+
cik: import("zod").ZodString;
|
|
728
|
+
company_name: import("zod").ZodString;
|
|
729
|
+
items_filter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
730
|
+
total_matched: import("zod").ZodNumber;
|
|
731
|
+
total_8k_scanned: import("zod").ZodNumber;
|
|
732
|
+
item_distribution: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>;
|
|
733
|
+
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
734
|
+
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
735
|
+
accession_number: import("zod").ZodString;
|
|
736
|
+
form: import("zod").ZodString;
|
|
737
|
+
filing_date: import("zod").ZodString;
|
|
738
|
+
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
739
|
+
primary_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
740
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
741
|
+
items: import("zod").ZodArray<import("zod").ZodObject<{
|
|
742
|
+
code: import("zod").ZodString;
|
|
743
|
+
label: import("zod").ZodOptional<import("zod").ZodString>;
|
|
744
|
+
regime: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
745
|
+
current: "current";
|
|
746
|
+
legacy: "legacy";
|
|
747
|
+
}>>;
|
|
748
|
+
}, import("zod/v4/core").$strip>>;
|
|
749
|
+
}, import("zod/v4/core").$strip>>;
|
|
750
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
751
|
+
name: import("zod").ZodString;
|
|
752
|
+
row_count: import("zod").ZodNumber;
|
|
753
|
+
expires_at: import("zod").ZodString;
|
|
754
|
+
truncated: import("zod").ZodBoolean;
|
|
755
|
+
}, import("zod/v4/core").$strip>>;
|
|
756
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
757
|
+
readonly reason: "no_match";
|
|
758
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
759
|
+
readonly when: "No company matches the query";
|
|
760
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK for an exact match, or find the company with secedgar_company_search.";
|
|
761
|
+
}, {
|
|
762
|
+
readonly reason: "multiple_matches";
|
|
763
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
764
|
+
readonly when: "The query is ambiguous and matches several companies";
|
|
765
|
+
readonly recovery: "Retry with a ticker symbol or the 10-digit CIK from the matches list.";
|
|
766
|
+
}, {
|
|
767
|
+
readonly reason: "rate_limited";
|
|
768
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
769
|
+
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";
|
|
770
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
771
|
+
readonly retryable: true;
|
|
772
|
+
readonly thrownBy: "service";
|
|
773
|
+
}, {
|
|
774
|
+
readonly reason: "sec_unreachable";
|
|
775
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
776
|
+
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";
|
|
777
|
+
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.";
|
|
778
|
+
readonly retryable: true;
|
|
779
|
+
readonly thrownBy: "service";
|
|
780
|
+
}], {
|
|
781
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
782
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
783
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
784
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
785
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
928
786
|
company: import("zod").ZodString;
|
|
929
787
|
transaction_type: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
930
788
|
all: "all";
|
|
@@ -962,9 +820,184 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
962
820
|
}>>;
|
|
963
821
|
ownership_nature: import("zod").ZodOptional<import("zod").ZodString>;
|
|
964
822
|
}, import("zod/v4/core").$strip>>;
|
|
965
|
-
filings_scanned: import("zod").ZodNumber;
|
|
966
|
-
filings_other_issuer: import("zod").ZodNumber;
|
|
967
|
-
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
823
|
+
filings_scanned: import("zod").ZodNumber;
|
|
824
|
+
filings_other_issuer: import("zod").ZodNumber;
|
|
825
|
+
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
826
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
827
|
+
name: import("zod").ZodString;
|
|
828
|
+
row_count: import("zod").ZodNumber;
|
|
829
|
+
expires_at: import("zod").ZodString;
|
|
830
|
+
truncated: import("zod").ZodBoolean;
|
|
831
|
+
}, import("zod/v4/core").$strip>>;
|
|
832
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
833
|
+
readonly reason: "company_not_found";
|
|
834
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
835
|
+
readonly when: "The company input does not resolve to a known company";
|
|
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.";
|
|
842
|
+
}, {
|
|
843
|
+
readonly reason: "no_filings_found";
|
|
844
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
845
|
+
readonly when: "A call without a date window finds no Form 4 filings in the recent submissions window";
|
|
846
|
+
readonly recovery: "Pass filed_after / filed_before to read an older period, or use secedgar_search_filings with forms=[\"4\"] to find the filings.";
|
|
847
|
+
}, {
|
|
848
|
+
readonly reason: "rate_limited";
|
|
849
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
850
|
+
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";
|
|
851
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
852
|
+
readonly retryable: true;
|
|
853
|
+
readonly thrownBy: "service";
|
|
854
|
+
}, {
|
|
855
|
+
readonly reason: "sec_unreachable";
|
|
856
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
857
|
+
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";
|
|
858
|
+
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.";
|
|
859
|
+
readonly retryable: true;
|
|
860
|
+
readonly thrownBy: "service";
|
|
861
|
+
}], {
|
|
862
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
863
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
864
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
865
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
866
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
867
|
+
issuer: import("zod").ZodString;
|
|
868
|
+
cusip: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
869
|
+
quarter: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
870
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
871
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
872
|
+
issuer: import("zod").ZodString;
|
|
873
|
+
resolved_issuer_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
874
|
+
resolved_issuer_cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
875
|
+
search_mode: import("zod").ZodEnum<{
|
|
876
|
+
cusip: "cusip";
|
|
877
|
+
name: "name";
|
|
878
|
+
}>;
|
|
879
|
+
search_key: import("zod").ZodString;
|
|
880
|
+
quarter: import("zod").ZodString;
|
|
881
|
+
filed_from: import("zod").ZodString;
|
|
882
|
+
filed_to: import("zod").ZodString;
|
|
883
|
+
total_filings: import("zod").ZodNumber;
|
|
884
|
+
total_is_exact: import("zod").ZodBoolean;
|
|
885
|
+
fetched: import("zod").ZodNumber;
|
|
886
|
+
holders_in_quarter: import("zod").ZodNumber;
|
|
887
|
+
holders: import("zod").ZodArray<import("zod").ZodObject<{
|
|
888
|
+
filer_name: import("zod").ZodString;
|
|
889
|
+
filer_cik: import("zod").ZodString;
|
|
890
|
+
accession_number: import("zod").ZodString;
|
|
891
|
+
filing_date: import("zod").ZodString;
|
|
892
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
893
|
+
}, import("zod/v4/core").$strip>>;
|
|
894
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
895
|
+
name: import("zod").ZodString;
|
|
896
|
+
row_count: import("zod").ZodNumber;
|
|
897
|
+
expires_at: import("zod").ZodString;
|
|
898
|
+
truncated: import("zod").ZodBoolean;
|
|
899
|
+
}, import("zod/v4/core").$strip>>;
|
|
900
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
901
|
+
readonly reason: "issuer_not_found";
|
|
902
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
903
|
+
readonly when: "No cusip was given and the issuer does not resolve to a known EDGAR company";
|
|
904
|
+
readonly recovery: "Confirm the issuer with secedgar_company_search, or pass the cusip parameter to search the information tables directly.";
|
|
905
|
+
}, {
|
|
906
|
+
readonly reason: "ambiguous_issuer";
|
|
907
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
908
|
+
readonly when: "The issuer name matches several EDGAR companies and no cusip was given";
|
|
909
|
+
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
910
|
+
}, {
|
|
911
|
+
readonly reason: "rate_limited";
|
|
912
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
913
|
+
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";
|
|
914
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
915
|
+
readonly retryable: true;
|
|
916
|
+
readonly thrownBy: "service";
|
|
917
|
+
}, {
|
|
918
|
+
readonly reason: "sec_unreachable";
|
|
919
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
920
|
+
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";
|
|
921
|
+
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.";
|
|
922
|
+
readonly retryable: true;
|
|
923
|
+
readonly thrownBy: "service";
|
|
924
|
+
}, {
|
|
925
|
+
readonly reason: "efts_degraded_response";
|
|
926
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
927
|
+
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";
|
|
928
|
+
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
929
|
+
readonly retryable: true;
|
|
930
|
+
readonly thrownBy: "service";
|
|
931
|
+
}], {
|
|
932
|
+
readonly ordering: import("zod").ZodString;
|
|
933
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
934
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
935
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
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>>;
|
|
968
1001
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
969
1002
|
name: import("zod").ZodString;
|
|
970
1003
|
row_count: import("zod").ZodNumber;
|
|
@@ -972,15 +1005,20 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
972
1005
|
truncated: import("zod").ZodBoolean;
|
|
973
1006
|
}, import("zod/v4/core").$strip>>;
|
|
974
1007
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
975
|
-
readonly reason: "
|
|
1008
|
+
readonly reason: "issuer_not_found";
|
|
976
1009
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
977
|
-
readonly when: "The
|
|
978
|
-
readonly recovery: "Use secedgar_company_search to find the
|
|
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.";
|
|
979
1017
|
}, {
|
|
980
1018
|
readonly reason: "no_filings_found";
|
|
981
1019
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
982
|
-
readonly when: "
|
|
983
|
-
readonly recovery: "
|
|
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.";
|
|
984
1022
|
}, {
|
|
985
1023
|
readonly reason: "rate_limited";
|
|
986
1024
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1001,74 +1039,47 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1001
1039
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1002
1040
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1003
1041
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1004
|
-
|
|
1005
|
-
|
|
1042
|
+
fund: import("zod").ZodString;
|
|
1043
|
+
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1044
|
+
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1006
1045
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1007
1046
|
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1008
|
-
consolidate: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
1009
1047
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1048
|
+
fund: import("zod").ZodString;
|
|
1049
|
+
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1050
|
+
series_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1051
|
+
class_ids: import("zod").ZodArray<import("zod").ZodString>;
|
|
1052
|
+
registrant_cik: import("zod").ZodString;
|
|
1053
|
+
registrant_name: import("zod").ZodString;
|
|
1054
|
+
report_period_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1055
|
+
report_period_end: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1013
1056
|
filing_date: import("zod").ZodString;
|
|
1057
|
+
publication_lag_days: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1058
|
+
form: import("zod").ZodString;
|
|
1014
1059
|
accession_number: import("zod").ZodString;
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
not_applied: "not_applied";
|
|
1021
|
-
restatement: "restatement";
|
|
1022
|
-
superseded: "superseded";
|
|
1023
|
-
}>;
|
|
1024
|
-
amendment_type: import("zod").ZodEnum<{
|
|
1025
|
-
"NEW HOLDINGS": "NEW HOLDINGS";
|
|
1026
|
-
RESTATEMENT: "RESTATEMENT";
|
|
1027
|
-
}>;
|
|
1028
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1029
|
-
accession_number: import("zod").ZodString;
|
|
1030
|
-
filing_date: import("zod").ZodString;
|
|
1031
|
-
applied_as: import("zod").ZodEnum<{
|
|
1032
|
-
new_holdings: "new_holdings";
|
|
1033
|
-
not_applied: "not_applied";
|
|
1034
|
-
restatement: "restatement";
|
|
1035
|
-
superseded: "superseded";
|
|
1036
|
-
}>;
|
|
1037
|
-
amendment_type: import("zod").ZodLiteral<"UNAVAILABLE">;
|
|
1038
|
-
unavailable_reason: import("zod").ZodEnum<{
|
|
1039
|
-
lookup_failed: "lookup_failed";
|
|
1040
|
-
lookup_stopped: "lookup_stopped";
|
|
1041
|
-
missing_header: "missing_header";
|
|
1042
|
-
unreadable_header: "unreadable_header";
|
|
1043
|
-
}>;
|
|
1044
|
-
}, import("zod/v4/core").$strip>], "amendment_type">>>;
|
|
1045
|
-
amendment_search_complete: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1046
|
-
composed_accessions: import("zod").ZodArray<import("zod").ZodString>;
|
|
1047
|
-
total_holdings_in_filing: import("zod").ZodNumber;
|
|
1048
|
-
total_holdings_composed: import("zod").ZodNumber;
|
|
1049
|
-
total_positions: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1060
|
+
is_final_filing: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1061
|
+
net_assets_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1062
|
+
total_assets_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1063
|
+
total_liabilities_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1064
|
+
total_holdings: import("zod").ZodNumber;
|
|
1050
1065
|
offset: import("zod").ZodNumber;
|
|
1051
1066
|
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1067
|
+
available_report_periods: import("zod").ZodArray<import("zod").ZodString>;
|
|
1052
1068
|
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1053
|
-
|
|
1054
|
-
|
|
1069
|
+
name: import("zod").ZodString;
|
|
1070
|
+
title: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1055
1071
|
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
DFND: "DFND";
|
|
1068
|
-
OTR: "OTR";
|
|
1069
|
-
SOLE: "SOLE";
|
|
1070
|
-
}>>;
|
|
1071
|
-
source_accession_numbers: import("zod").ZodArray<import("zod").ZodString>;
|
|
1072
|
+
isin: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1073
|
+
lei: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1074
|
+
balance: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1075
|
+
units: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1076
|
+
currency: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1077
|
+
value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1078
|
+
percent_of_net_assets: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1079
|
+
payoff_profile: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1080
|
+
asset_category: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1081
|
+
issuer_category: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1082
|
+
country: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1072
1083
|
}, import("zod/v4/core").$strip>>;
|
|
1073
1084
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1074
1085
|
name: import("zod").ZodString;
|
|
@@ -1076,25 +1087,25 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1076
1087
|
expires_at: import("zod").ZodString;
|
|
1077
1088
|
}, import("zod/v4/core").$strip>>;
|
|
1078
1089
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1079
|
-
readonly reason: "
|
|
1090
|
+
readonly reason: "fund_not_found";
|
|
1080
1091
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1081
|
-
readonly when: "The
|
|
1082
|
-
readonly recovery: "Use secedgar_company_search to
|
|
1092
|
+
readonly when: "The fund input resolves to neither an EDGAR company nor a known fund series";
|
|
1093
|
+
readonly recovery: "Use secedgar_company_search with the fund ticker to get its CIK and series ID.";
|
|
1083
1094
|
}, {
|
|
1084
|
-
readonly reason: "
|
|
1095
|
+
readonly reason: "ambiguous_fund";
|
|
1085
1096
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1086
|
-
readonly when: "The name
|
|
1087
|
-
readonly recovery: "Retry with the
|
|
1097
|
+
readonly when: "The fund name matches several EDGAR companies";
|
|
1098
|
+
readonly recovery: "Retry with the fund ticker or the 10-digit CIK from the matches list.";
|
|
1088
1099
|
}, {
|
|
1089
|
-
readonly reason: "
|
|
1090
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
1091
|
-
readonly when: "
|
|
1092
|
-
readonly recovery: "
|
|
1100
|
+
readonly reason: "series_required";
|
|
1101
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1102
|
+
readonly when: "The input resolves to a registrant trust that files reports for more than one fund series";
|
|
1103
|
+
readonly recovery: "Retry with series_id set to one of the listed series, or pass a fund ticker.";
|
|
1093
1104
|
}, {
|
|
1094
|
-
readonly reason: "
|
|
1105
|
+
readonly reason: "no_filings_found";
|
|
1095
1106
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1096
|
-
readonly when: "
|
|
1097
|
-
readonly recovery: "
|
|
1107
|
+
readonly when: "No NPORT-P report exists for this fund, or none covers the report_date requested";
|
|
1108
|
+
readonly recovery: "Drop report_date to take the newest report, or use secedgar_search_filings with forms [\"NPORT-P\"] to see what the registrant has filed.";
|
|
1098
1109
|
}, {
|
|
1099
1110
|
readonly reason: "rate_limited";
|
|
1100
1111
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1110,54 +1121,95 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1110
1121
|
readonly retryable: true;
|
|
1111
1122
|
readonly thrownBy: "service";
|
|
1112
1123
|
}], {
|
|
1124
|
+
readonly as_of: import("zod").ZodString;
|
|
1113
1125
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1114
1126
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1115
1127
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1116
1128
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1117
1129
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
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>;
|
|
1122
1141
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
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;
|
|
1141
1178
|
accession_number: import("zod").ZodString;
|
|
1142
|
-
filing_date: import("zod").ZodString;
|
|
1143
|
-
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1144
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>;
|
|
1145
1193
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1146
1194
|
name: import("zod").ZodString;
|
|
1147
1195
|
row_count: import("zod").ZodNumber;
|
|
1148
1196
|
expires_at: import("zod").ZodString;
|
|
1149
|
-
truncated: import("zod").ZodBoolean;
|
|
1150
1197
|
}, import("zod/v4/core").$strip>>;
|
|
1151
1198
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1152
|
-
readonly reason: "
|
|
1199
|
+
readonly reason: "no_companies_resolved";
|
|
1153
1200
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1154
|
-
readonly when: "
|
|
1155
|
-
readonly recovery: "
|
|
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.";
|
|
1156
1203
|
}, {
|
|
1157
|
-
readonly reason: "
|
|
1158
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
1159
|
-
readonly when: "
|
|
1160
|
-
readonly recovery: "
|
|
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.";
|
|
1161
1213
|
}, {
|
|
1162
1214
|
readonly reason: "rate_limited";
|
|
1163
1215
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1173,7 +1225,6 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1173
1225
|
readonly retryable: true;
|
|
1174
1226
|
readonly thrownBy: "service";
|
|
1175
1227
|
}], {
|
|
1176
|
-
readonly ordering: import("zod").ZodString;
|
|
1177
1228
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1178
1229
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1179
1230
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -1324,15 +1375,5 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1324
1375
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1325
1376
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1326
1377
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1327
|
-
}>
|
|
1328
|
-
name: import("zod").ZodString;
|
|
1329
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1330
|
-
name: import("zod").ZodString;
|
|
1331
|
-
dropped: import("zod").ZodBoolean;
|
|
1332
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
1333
|
-
readonly reason: "canvas_unavailable";
|
|
1334
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
1335
|
-
readonly when: "The DataCanvas service is not configured for this deployment";
|
|
1336
|
-
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.";
|
|
1337
|
-
}], undefined>)[];
|
|
1378
|
+
}>)[];
|
|
1338
1379
|
//# sourceMappingURL=index.d.ts.map
|