@cyanheads/secedgar-mcp-server 0.17.1 → 0.18.1
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 +8 -5
- package/CLAUDE.md +8 -5
- package/README.md +4 -3
- package/changelog/0.18.x/0.18.0.md +16 -0
- package/changelog/0.18.x/0.18.1.md +38 -0
- package/dist/mcp-server/tools/ambiguous-matches.d.ts +59 -0
- package/dist/mcp-server/tools/ambiguous-matches.d.ts.map +1 -0
- package/dist/mcp-server/tools/ambiguous-matches.js +31 -0
- package/dist/mcp-server/tools/ambiguous-matches.js.map +1 -0
- package/dist/mcp-server/tools/definitions/company-search.tool.d.ts +8 -8
- package/dist/mcp-server/tools/definitions/company-search.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/company-search.tool.js +18 -17
- package/dist/mcp-server/tools/definitions/company-search.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/compare-companies.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/compare-companies.tool.js +25 -16
- 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.map +1 -1
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.js +12 -7
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/find-holders.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/find-holders.tool.js +51 -13
- 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.map +1 -1
- package/dist/mcp-server/tools/definitions/get-beneficial-owners.tool.js +16 -14
- 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.map +1 -1
- package/dist/mcp-server/tools/definitions/get-filing.tool.js +26 -13
- 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 +14 -21
- 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.map +1 -1
- package/dist/mcp-server/tools/definitions/get-institutional-holdings.tool.js +26 -26
- 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 +8 -8
- 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 +13 -14
- 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 +452 -441
- 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 +12 -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 +34 -10
- 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/services/edgar/edgar-api-service.d.ts +50 -11
- package/dist/services/edgar/edgar-api-service.d.ts.map +1 -1
- package/dist/services/edgar/edgar-api-service.js +102 -36
- package/dist/services/edgar/edgar-api-service.js.map +1 -1
- package/package.json +2 -2
- package/server.json +3 -3
|
@@ -30,413 +30,29 @@ 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
|
-
concepts: import("zod").ZodArray<import("zod").ZodString>;
|
|
35
|
-
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
36
|
-
"ifrs-full": "ifrs-full";
|
|
37
|
-
"us-gaap": "us-gaap";
|
|
38
|
-
}>>;
|
|
39
|
-
period_type: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
40
|
-
annual: "annual";
|
|
41
|
-
quarterly: "quarterly";
|
|
42
|
-
}>>;
|
|
43
|
-
periods: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
44
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
45
|
-
period_type: import("zod").ZodString;
|
|
46
|
-
taxonomy: import("zod").ZodString;
|
|
47
|
-
periods: import("zod").ZodArray<import("zod").ZodString>;
|
|
48
|
-
companies: import("zod").ZodArray<import("zod").ZodObject<{
|
|
49
|
-
input: import("zod").ZodString;
|
|
50
|
-
cik: import("zod").ZodString;
|
|
51
|
-
name: import("zod").ZodString;
|
|
52
|
-
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
53
|
-
}, import("zod/v4/core").$strip>>;
|
|
54
|
-
failed_companies: import("zod").ZodArray<import("zod").ZodObject<{
|
|
55
|
-
input: import("zod").ZodString;
|
|
56
|
-
reason: import("zod").ZodEnum<{
|
|
57
|
-
ambiguous: "ambiguous";
|
|
58
|
-
no_company_facts: "no_company_facts";
|
|
59
|
-
not_found: "not_found";
|
|
60
|
-
}>;
|
|
61
|
-
message: import("zod").ZodString;
|
|
62
|
-
}, import("zod/v4/core").$strip>>;
|
|
63
|
-
deferred_companies: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
64
|
-
concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
65
|
-
concept: import("zod").ZodString;
|
|
66
|
-
label: import("zod").ZodString;
|
|
67
|
-
units: import("zod").ZodArray<import("zod").ZodString>;
|
|
68
|
-
}, import("zod/v4/core").$strip>>;
|
|
69
|
-
cells: import("zod").ZodArray<import("zod").ZodObject<{
|
|
70
|
-
cik: import("zod").ZodString;
|
|
71
|
-
company: import("zod").ZodString;
|
|
72
|
-
concept: import("zod").ZodString;
|
|
73
|
-
period: import("zod").ZodString;
|
|
74
|
-
value: import("zod").ZodNumber;
|
|
75
|
-
unit: import("zod").ZodString;
|
|
76
|
-
taxonomy: import("zod").ZodString;
|
|
77
|
-
tag: import("zod").ZodString;
|
|
78
|
-
frame: import("zod").ZodString;
|
|
79
|
-
period_end: import("zod").ZodString;
|
|
80
|
-
form: import("zod").ZodString;
|
|
81
|
-
accession_number: import("zod").ZodString;
|
|
82
|
-
}, import("zod/v4/core").$strip>>;
|
|
83
|
-
gaps: import("zod").ZodArray<import("zod").ZodObject<{
|
|
84
|
-
cik: import("zod").ZodString;
|
|
85
|
-
company: import("zod").ZodString;
|
|
86
|
-
concept: import("zod").ZodString;
|
|
87
|
-
tags_tried: import("zod").ZodArray<import("zod").ZodString>;
|
|
88
|
-
}, import("zod/v4/core").$strip>>;
|
|
89
|
-
unknown_concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
90
|
-
concept: import("zod").ZodString;
|
|
91
|
-
derivation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
92
|
-
suggestions: import("zod").ZodArray<import("zod").ZodString>;
|
|
93
|
-
}, import("zod/v4/core").$strip>>;
|
|
94
|
-
deferred_concepts: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
95
|
-
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
96
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
97
|
-
name: import("zod").ZodString;
|
|
98
|
-
row_count: import("zod").ZodNumber;
|
|
99
|
-
expires_at: import("zod").ZodString;
|
|
100
|
-
}, import("zod/v4/core").$strip>>;
|
|
101
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
102
|
-
readonly reason: "no_companies_resolved";
|
|
103
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
104
|
-
readonly when: "None of the company inputs read resolved to a CIK; inputs past the caps were not read and are named in deferred_companies and deferred_concepts";
|
|
105
|
-
readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
|
|
106
|
-
}, {
|
|
107
|
-
readonly reason: "no_comparable_data";
|
|
108
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
109
|
-
readonly when: "Companies resolved but not one of them reports any of the requested concepts for the requested period type; any company or concept inputs past the caps are named, unread, in deferred_companies and deferred_concepts";
|
|
110
|
-
readonly recovery: "Switch period_type, or discover reported concept names with secedgar_search_concepts.";
|
|
111
|
-
}, {
|
|
112
|
-
readonly reason: "unknown_concept";
|
|
113
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
114
|
-
readonly when: "Every requested concept is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
|
|
115
|
-
readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
|
|
116
|
-
}, {
|
|
117
|
-
readonly reason: "rate_limited";
|
|
118
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
119
|
-
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";
|
|
120
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
121
|
-
readonly retryable: true;
|
|
122
|
-
readonly thrownBy: "service";
|
|
123
|
-
}, {
|
|
124
|
-
readonly reason: "sec_unreachable";
|
|
125
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
126
|
-
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";
|
|
127
|
-
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.";
|
|
128
|
-
readonly retryable: true;
|
|
129
|
-
readonly thrownBy: "service";
|
|
130
|
-
}], {
|
|
131
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
132
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
133
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
134
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
135
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
136
|
-
concept: import("zod").ZodString;
|
|
137
|
-
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
138
|
-
dei: "dei";
|
|
139
|
-
"us-gaap": "us-gaap";
|
|
140
|
-
}>>;
|
|
141
|
-
period: import("zod").ZodString;
|
|
142
|
-
unit: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
143
|
-
USD: "USD";
|
|
144
|
-
"USD-per-shares": "USD-per-shares";
|
|
145
|
-
"USD/shares": "USD/shares";
|
|
146
|
-
pure: "pure";
|
|
147
|
-
shares: "shares";
|
|
148
|
-
}>>;
|
|
149
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
150
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
151
|
-
sort: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
152
|
-
asc: "asc";
|
|
153
|
-
desc: "desc";
|
|
154
|
-
}>>;
|
|
155
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
156
|
-
concept: import("zod").ZodString;
|
|
157
|
-
taxonomy: import("zod").ZodString;
|
|
158
|
-
period: import("zod").ZodString;
|
|
159
|
-
unit: import("zod").ZodString;
|
|
160
|
-
label: import("zod").ZodString;
|
|
161
|
-
total_companies: import("zod").ZodNumber;
|
|
162
|
-
offset: import("zod").ZodNumber;
|
|
163
|
-
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
164
|
-
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
165
|
-
rank: import("zod").ZodNumber;
|
|
166
|
-
company_name: import("zod").ZodString;
|
|
167
|
-
cik: import("zod").ZodString;
|
|
168
|
-
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
169
|
-
value: import("zod").ZodNumber;
|
|
170
|
-
location: import("zod").ZodOptional<import("zod").ZodString>;
|
|
171
|
-
period_end: import("zod").ZodString;
|
|
172
|
-
accession_number: import("zod").ZodString;
|
|
173
|
-
}, import("zod/v4/core").$strip>>;
|
|
174
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
175
|
-
name: import("zod").ZodString;
|
|
176
|
-
row_count: import("zod").ZodNumber;
|
|
177
|
-
expires_at: import("zod").ZodString;
|
|
178
|
-
}, import("zod/v4/core").$strip>>;
|
|
179
|
-
unqueried_tags: import("zod").ZodArray<import("zod").ZodString>;
|
|
180
|
-
related_tags: import("zod").ZodArray<import("zod").ZodObject<{
|
|
181
|
-
tag: import("zod").ZodString;
|
|
182
|
-
note: import("zod").ZodString;
|
|
183
|
-
}, import("zod/v4/core").$strip>>;
|
|
184
|
-
value_distribution: import("zod").ZodObject<{
|
|
185
|
-
median: import("zod").ZodNumber;
|
|
186
|
-
p95: import("zod").ZodNumber;
|
|
187
|
-
max: import("zod").ZodNumber;
|
|
188
|
-
max_to_p95_ratio: import("zod").ZodNumber;
|
|
189
|
-
}, import("zod/v4/core").$strip>;
|
|
190
|
-
period_end_range: import("zod").ZodObject<{
|
|
191
|
-
min: import("zod").ZodString;
|
|
192
|
-
max: import("zod").ZodString;
|
|
193
|
-
}, import("zod/v4/core").$strip>;
|
|
194
|
-
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
195
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
196
|
-
readonly reason: "unknown_concept";
|
|
197
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
198
|
-
readonly when: "The concept input is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
|
|
199
|
-
readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
|
|
200
|
-
}, {
|
|
201
|
-
readonly reason: "no_data";
|
|
202
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
203
|
-
readonly when: "Concept resolves but no companies report the tag this call read for the requested period and unit";
|
|
204
|
-
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.";
|
|
205
|
-
}, {
|
|
206
|
-
readonly reason: "rate_limited";
|
|
207
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
208
|
-
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";
|
|
209
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
210
|
-
readonly retryable: true;
|
|
211
|
-
readonly thrownBy: "service";
|
|
212
|
-
}, {
|
|
213
|
-
readonly reason: "sec_unreachable";
|
|
214
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
215
|
-
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";
|
|
216
|
-
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.";
|
|
217
|
-
readonly retryable: true;
|
|
218
|
-
readonly thrownBy: "service";
|
|
219
|
-
}], {
|
|
220
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
221
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
222
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
223
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
224
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
225
|
-
query: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
226
|
-
forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
227
|
-
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
228
|
-
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
229
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
230
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
231
|
-
sort: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
232
|
-
filing_date_asc: "filing_date_asc";
|
|
233
|
-
filing_date_desc: "filing_date_desc";
|
|
234
|
-
relevance: "relevance";
|
|
235
|
-
}>>;
|
|
33
|
+
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
236
34
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
237
|
-
|
|
238
|
-
total_is_exact: import("zod").ZodBoolean;
|
|
239
|
-
total_documents: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
240
|
-
results: import("zod").ZodArray<import("zod").ZodObject<{
|
|
241
|
-
accession_number: import("zod").ZodString;
|
|
242
|
-
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
243
|
-
filing_date: import("zod").ZodString;
|
|
244
|
-
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
245
|
-
company_name: import("zod").ZodString;
|
|
246
|
-
cik: import("zod").ZodString;
|
|
247
|
-
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
248
|
-
file_description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
249
|
-
matched_documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
250
|
-
name: import("zod").ZodString;
|
|
251
|
-
type: import("zod").ZodOptional<import("zod").ZodString>;
|
|
252
|
-
}, import("zod/v4/core").$strip>>>;
|
|
253
|
-
sic: import("zod").ZodOptional<import("zod").ZodString>;
|
|
254
|
-
location: import("zod").ZodOptional<import("zod").ZodString>;
|
|
255
|
-
source: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
256
|
-
efts: "efts";
|
|
257
|
-
"full-index": "full-index";
|
|
258
|
-
submissions: "submissions";
|
|
259
|
-
}>>;
|
|
260
|
-
}, import("zod/v4/core").$strip>>;
|
|
261
|
-
form_distribution: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>>;
|
|
262
|
-
scan: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
263
|
-
candidates: import("zod").ZodNumber;
|
|
264
|
-
scanned: import("zod").ZodNumber;
|
|
265
|
-
matched: import("zod").ZodNumber;
|
|
266
|
-
capped: import("zod").ZodBoolean;
|
|
267
|
-
}, import("zod/v4/core").$strip>>;
|
|
268
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
35
|
+
dataframes: import("zod").ZodArray<import("zod").ZodObject<{
|
|
269
36
|
name: import("zod").ZodString;
|
|
270
|
-
|
|
37
|
+
source_tool: import("zod").ZodString;
|
|
38
|
+
query_params: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
|
|
39
|
+
created_at: import("zod").ZodString;
|
|
271
40
|
expires_at: import("zod").ZodString;
|
|
272
|
-
truncated: import("zod").ZodBoolean;
|
|
273
|
-
}, import("zod/v4/core").$strip>>;
|
|
274
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
275
|
-
readonly reason: "unresolved_ticker";
|
|
276
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
277
|
-
readonly when: "A ticker: targeting token in the query does not resolve to a known company";
|
|
278
|
-
readonly recovery: "Verify the symbol with secedgar_company_search, or target by CIK with cik:<number> instead.";
|
|
279
|
-
readonly thrownBy: "service";
|
|
280
|
-
}, {
|
|
281
|
-
readonly reason: "invalid_cik";
|
|
282
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
283
|
-
readonly when: "A cik: targeting token in the query is not a 1-10 digit number";
|
|
284
|
-
readonly recovery: "Pass a numeric CIK such as cik:320193 — find it with secedgar_company_search if unknown.";
|
|
285
|
-
readonly thrownBy: "service";
|
|
286
|
-
}, {
|
|
287
|
-
readonly reason: "entity_not_found";
|
|
288
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
289
|
-
readonly when: "A cik: targeting token on a pre-2001 date range names a CIK with no EDGAR submissions history";
|
|
290
|
-
readonly recovery: "Confirm the CIK with secedgar_company_search — an accession-number prefix names the filing agent, not the issuer.";
|
|
291
|
-
readonly thrownBy: "service";
|
|
292
|
-
}, {
|
|
293
|
-
readonly reason: "missing_criteria";
|
|
294
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
295
|
-
readonly when: "Neither a full-text query nor a forms filter was provided (a date range cannot stand alone)";
|
|
296
|
-
readonly recovery: "Provide search terms, or browse by form type (forms: [\"S-1\"]) or entity (ticker:AAPL / cik:320193 in the query) — optionally narrowed by date.";
|
|
297
|
-
}, {
|
|
298
|
-
readonly reason: "pre2001_full_text_unscoped";
|
|
299
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
300
|
-
readonly when: "A date range reaching before 2001-01-01 carries free-text terms with no entity scope — no pre-2001 full-text index exists, and nothing bounds a local scan";
|
|
301
|
-
readonly recovery: "Add ticker: or cik: entity scope to the query, drop the text terms and browse by form type (forms: [\"10-K\"]) and date, or, for a range that reaches 2001, start the range at 2001-01-01.";
|
|
302
|
-
}, {
|
|
303
|
-
readonly reason: "offset_out_of_range";
|
|
304
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
305
|
-
readonly when: "A sort=relevance search with no ticker:/cik: scope and no date range reaching before 2001 asks for an offset above 9900, past the deepest page EDGAR full-text search serves";
|
|
306
|
-
readonly recovery: "Use an offset of 9900 or less — a page there with limit 100 reaches EDGAR's 10,000-document cap — or narrow the search with a shorter filed_after/filed_before window, a forms filter, or more specific terms so fewer documents match.";
|
|
307
|
-
readonly retryable: false;
|
|
308
|
-
}, {
|
|
309
|
-
readonly reason: "rate_limited";
|
|
310
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
311
|
-
readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
|
|
312
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
313
|
-
readonly retryable: true;
|
|
314
|
-
readonly thrownBy: "service";
|
|
315
|
-
}, {
|
|
316
|
-
readonly reason: "sec_unreachable";
|
|
317
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
318
|
-
readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
|
|
319
|
-
readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
|
|
320
|
-
readonly retryable: true;
|
|
321
|
-
readonly thrownBy: "service";
|
|
322
|
-
}, {
|
|
323
|
-
readonly reason: "efts_degraded_response";
|
|
324
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
325
|
-
readonly when: "EDGAR full-text search answered without results — its search backend failed to run the search on every attempt made (a connection or timeout failure, retried like a request SEC never answered), refused the request (upstreamErrorType and upstreamErrorMessage carry its error, and the request is not retried), or sent a payload with no hit list";
|
|
326
|
-
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
327
|
-
readonly retryable: true;
|
|
328
|
-
readonly thrownBy: "service";
|
|
329
|
-
}], {
|
|
330
|
-
readonly effectiveQuery: import("zod").ZodString;
|
|
331
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
332
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
333
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
334
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
335
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
336
|
-
issuer: import("zod").ZodString;
|
|
337
|
-
form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
338
|
-
"13D": "13D";
|
|
339
|
-
"13G": "13G";
|
|
340
|
-
all: "all";
|
|
341
|
-
}>>;
|
|
342
|
-
include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
343
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
344
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
345
|
-
issuer: import("zod").ZodString;
|
|
346
|
-
issuer_cik: import("zod").ZodString;
|
|
347
|
-
issuer_name: import("zod").ZodString;
|
|
348
|
-
form_kind: import("zod").ZodEnum<{
|
|
349
|
-
"13D": "13D";
|
|
350
|
-
"13G": "13G";
|
|
351
|
-
all: "all";
|
|
352
|
-
}>;
|
|
353
|
-
total_structured_filings: import("zod").ZodNumber;
|
|
354
|
-
filings_parsed: import("zod").ZodNumber;
|
|
355
|
-
filings_examined: import("zod").ZodNumber;
|
|
356
|
-
filings_excluded_other_issuer: import("zod").ZodNumber;
|
|
357
|
-
filings_not_examined: import("zod").ZodNumber;
|
|
358
|
-
filings_failed: import("zod").ZodArray<import("zod").ZodObject<{
|
|
359
|
-
accession_number: import("zod").ZodString;
|
|
360
|
-
reason: import("zod").ZodEnum<{
|
|
361
|
-
document_not_found: "document_not_found";
|
|
362
|
-
unparseable: "unparseable";
|
|
363
|
-
}>;
|
|
364
|
-
}, import("zod/v4/core").$strip>>;
|
|
365
|
-
partial: import("zod").ZodBoolean;
|
|
366
|
-
structured_coverage_from: import("zod").ZodString;
|
|
367
|
-
legacy_filings_before_coverage: import("zod").ZodNumber;
|
|
368
|
-
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
369
|
-
form: import("zod").ZodString;
|
|
370
|
-
schedule: import("zod").ZodEnum<{
|
|
371
|
-
"13D": "13D";
|
|
372
|
-
"13G": "13G";
|
|
373
|
-
}>;
|
|
374
|
-
is_amendment: import("zod").ZodBoolean;
|
|
375
|
-
amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
|
|
376
|
-
accession_number: import("zod").ZodString;
|
|
377
|
-
filing_date: import("zod").ZodString;
|
|
378
|
-
event_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
379
|
-
security_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
380
|
-
cusips: import("zod").ZodArray<import("zod").ZodString>;
|
|
381
|
-
purpose_of_transaction: import("zod").ZodOptional<import("zod").ZodString>;
|
|
382
|
-
purpose_truncated: import("zod").ZodBoolean;
|
|
383
|
-
reporting_persons: import("zod").ZodArray<import("zod").ZodObject<{
|
|
384
|
-
name: import("zod").ZodString;
|
|
385
|
-
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
386
|
-
citizenship: import("zod").ZodOptional<import("zod").ZodString>;
|
|
387
|
-
percent_of_class: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
388
|
-
aggregate_amount_owned: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
389
|
-
sole_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
390
|
-
shared_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
391
|
-
sole_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
392
|
-
shared_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
393
|
-
person_types: import("zod").ZodArray<import("zod").ZodString>;
|
|
394
|
-
excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
395
|
-
notes: import("zod").ZodOptional<import("zod").ZodString>;
|
|
396
|
-
notes_truncated: import("zod").ZodBoolean;
|
|
397
|
-
}, import("zod/v4/core").$strip>>;
|
|
398
|
-
}, import("zod/v4/core").$strip>>;
|
|
399
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
400
|
-
name: import("zod").ZodString;
|
|
401
41
|
row_count: import("zod").ZodNumber;
|
|
402
|
-
expires_at: import("zod").ZodString;
|
|
403
42
|
truncated: import("zod").ZodBoolean;
|
|
43
|
+
max_rows: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
44
|
+
column_schema: import("zod").ZodArray<import("zod").ZodObject<{
|
|
45
|
+
name: import("zod").ZodString;
|
|
46
|
+
type: import("zod").ZodString;
|
|
47
|
+
nullable: import("zod").ZodBoolean;
|
|
48
|
+
}, import("zod/v4/core").$strip>>;
|
|
404
49
|
}, import("zod/v4/core").$strip>>;
|
|
405
50
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
406
|
-
readonly reason: "
|
|
407
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
408
|
-
readonly when: "The issuer input does not resolve to a known EDGAR company";
|
|
409
|
-
readonly recovery: "Use secedgar_company_search to find the issuer ticker or 10-digit CIK.";
|
|
410
|
-
}, {
|
|
411
|
-
readonly reason: "ambiguous_issuer";
|
|
412
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
413
|
-
readonly when: "The issuer name matches several EDGAR companies";
|
|
414
|
-
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
415
|
-
}, {
|
|
416
|
-
readonly reason: "no_filings_found";
|
|
417
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
418
|
-
readonly when: "The issuer has no structured SCHEDULE 13D/13G filings matching the requested form kind";
|
|
419
|
-
readonly recovery: "Use secedgar_search_filings with forms [\"SC 13D\",\"SC 13G\"] to reach the pre-2024-12-18 text filings, then read them with secedgar_get_filing.";
|
|
420
|
-
}, {
|
|
421
|
-
readonly reason: "rate_limited";
|
|
422
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
423
|
-
readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
|
|
424
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
425
|
-
readonly retryable: true;
|
|
426
|
-
readonly thrownBy: "service";
|
|
427
|
-
}, {
|
|
428
|
-
readonly reason: "sec_unreachable";
|
|
51
|
+
readonly reason: "canvas_unavailable";
|
|
429
52
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
430
|
-
readonly when: "
|
|
431
|
-
readonly recovery: "
|
|
432
|
-
|
|
433
|
-
readonly thrownBy: "service";
|
|
434
|
-
}], {
|
|
435
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
436
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
437
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
438
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
439
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
53
|
+
readonly when: "The DataCanvas service is not configured for this deployment";
|
|
54
|
+
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.";
|
|
55
|
+
}], undefined> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
440
56
|
company: import("zod").ZodString;
|
|
441
57
|
quarter: import("zod").ZodOptional<import("zod").ZodString>;
|
|
442
58
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
@@ -597,10 +213,119 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
597
213
|
readonly when: "No company matches the query";
|
|
598
214
|
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.";
|
|
599
215
|
}, {
|
|
600
|
-
readonly reason: "
|
|
216
|
+
readonly reason: "ambiguous_company";
|
|
217
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
218
|
+
readonly when: "The company input resolves to multiple entities and the target is ambiguous";
|
|
219
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK from the matches list for an exact match.";
|
|
220
|
+
}, {
|
|
221
|
+
readonly reason: "rate_limited";
|
|
222
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
223
|
+
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";
|
|
224
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
225
|
+
readonly retryable: true;
|
|
226
|
+
readonly thrownBy: "service";
|
|
227
|
+
}, {
|
|
228
|
+
readonly reason: "sec_unreachable";
|
|
229
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
230
|
+
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";
|
|
231
|
+
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.";
|
|
232
|
+
readonly retryable: true;
|
|
233
|
+
readonly thrownBy: "service";
|
|
234
|
+
}], {
|
|
235
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
236
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
237
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
238
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
239
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
240
|
+
query: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
241
|
+
forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
242
|
+
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
243
|
+
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
244
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
245
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
246
|
+
sort: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
247
|
+
filing_date_asc: "filing_date_asc";
|
|
248
|
+
filing_date_desc: "filing_date_desc";
|
|
249
|
+
relevance: "relevance";
|
|
250
|
+
}>>;
|
|
251
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
252
|
+
total: import("zod").ZodNumber;
|
|
253
|
+
total_is_exact: import("zod").ZodBoolean;
|
|
254
|
+
total_documents: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
255
|
+
results: import("zod").ZodArray<import("zod").ZodObject<{
|
|
256
|
+
accession_number: import("zod").ZodString;
|
|
257
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
258
|
+
filing_date: import("zod").ZodString;
|
|
259
|
+
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
260
|
+
company_name: import("zod").ZodString;
|
|
261
|
+
cik: import("zod").ZodString;
|
|
262
|
+
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
263
|
+
file_description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
264
|
+
matched_documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
265
|
+
name: import("zod").ZodString;
|
|
266
|
+
type: import("zod").ZodOptional<import("zod").ZodString>;
|
|
267
|
+
}, import("zod/v4/core").$strip>>>;
|
|
268
|
+
sic: import("zod").ZodOptional<import("zod").ZodString>;
|
|
269
|
+
location: import("zod").ZodOptional<import("zod").ZodString>;
|
|
270
|
+
source: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
271
|
+
efts: "efts";
|
|
272
|
+
"full-index": "full-index";
|
|
273
|
+
submissions: "submissions";
|
|
274
|
+
}>>;
|
|
275
|
+
}, import("zod/v4/core").$strip>>;
|
|
276
|
+
form_distribution: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>>;
|
|
277
|
+
scan: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
278
|
+
candidates: import("zod").ZodNumber;
|
|
279
|
+
scanned: import("zod").ZodNumber;
|
|
280
|
+
matched: import("zod").ZodNumber;
|
|
281
|
+
capped: import("zod").ZodBoolean;
|
|
282
|
+
}, import("zod/v4/core").$strip>>;
|
|
283
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
284
|
+
name: import("zod").ZodString;
|
|
285
|
+
row_count: import("zod").ZodNumber;
|
|
286
|
+
expires_at: import("zod").ZodString;
|
|
287
|
+
truncated: import("zod").ZodBoolean;
|
|
288
|
+
}, import("zod/v4/core").$strip>>;
|
|
289
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
290
|
+
readonly reason: "unresolved_ticker";
|
|
291
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
292
|
+
readonly when: "A ticker: targeting token in the query does not resolve to a known company";
|
|
293
|
+
readonly recovery: "Verify the symbol with secedgar_company_search, or target by CIK with cik:<number> instead.";
|
|
294
|
+
readonly thrownBy: "service";
|
|
295
|
+
}, {
|
|
296
|
+
readonly reason: "ambiguous_company";
|
|
297
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
298
|
+
readonly when: "A ticker: targeting token in the query resolves to multiple companies and the target is ambiguous";
|
|
299
|
+
readonly recovery: "Use ticker: or cik: with a ticker symbol or 10-digit CIK from the matches list for an exact match.";
|
|
300
|
+
readonly thrownBy: "service";
|
|
301
|
+
}, {
|
|
302
|
+
readonly reason: "invalid_cik";
|
|
303
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
304
|
+
readonly when: "A cik: targeting token in the query is not a 1-10 digit number";
|
|
305
|
+
readonly recovery: "Pass a numeric CIK such as cik:320193 — find it with secedgar_company_search if unknown.";
|
|
306
|
+
readonly thrownBy: "service";
|
|
307
|
+
}, {
|
|
308
|
+
readonly reason: "entity_not_found";
|
|
601
309
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
602
|
-
readonly when: "
|
|
603
|
-
readonly recovery: "
|
|
310
|
+
readonly when: "A cik: targeting token on a pre-2001 date range names a CIK with no EDGAR submissions history";
|
|
311
|
+
readonly recovery: "Confirm the CIK with secedgar_company_search — an accession-number prefix names the filing agent, not the issuer.";
|
|
312
|
+
readonly thrownBy: "service";
|
|
313
|
+
}, {
|
|
314
|
+
readonly reason: "missing_criteria";
|
|
315
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
316
|
+
readonly when: "Neither a full-text query nor a forms filter was provided (a date range cannot stand alone)";
|
|
317
|
+
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.";
|
|
318
|
+
}, {
|
|
319
|
+
readonly reason: "pre2001_full_text_unscoped";
|
|
320
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
321
|
+
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";
|
|
322
|
+
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.";
|
|
323
|
+
}, {
|
|
324
|
+
readonly reason: "offset_out_of_range";
|
|
325
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
326
|
+
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";
|
|
327
|
+
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.";
|
|
328
|
+
readonly retryable: false;
|
|
604
329
|
}, {
|
|
605
330
|
readonly reason: "rate_limited";
|
|
606
331
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -615,7 +340,15 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
615
340
|
readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
|
|
616
341
|
readonly retryable: true;
|
|
617
342
|
readonly thrownBy: "service";
|
|
343
|
+
}, {
|
|
344
|
+
readonly reason: "efts_degraded_response";
|
|
345
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
346
|
+
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";
|
|
347
|
+
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
348
|
+
readonly retryable: true;
|
|
349
|
+
readonly thrownBy: "service";
|
|
618
350
|
}], {
|
|
351
|
+
readonly effectiveQuery: import("zod").ZodString;
|
|
619
352
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
620
353
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
621
354
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -950,10 +683,10 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
950
683
|
readonly when: "No company matches the query";
|
|
951
684
|
readonly recovery: "Use a ticker symbol or 10-digit CIK for an exact match, or find the company with secedgar_company_search.";
|
|
952
685
|
}, {
|
|
953
|
-
readonly reason: "
|
|
954
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
955
|
-
readonly when: "The
|
|
956
|
-
readonly recovery: "
|
|
686
|
+
readonly reason: "ambiguous_company";
|
|
687
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
688
|
+
readonly when: "The company input resolves to multiple entities and the target is ambiguous";
|
|
689
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK from the matches list for an exact match.";
|
|
957
690
|
}, {
|
|
958
691
|
readonly reason: "rate_limited";
|
|
959
692
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1025,6 +758,11 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1025
758
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1026
759
|
readonly when: "The company input does not resolve to a known company";
|
|
1027
760
|
readonly recovery: "Use secedgar_company_search to find the correct ticker or CIK.";
|
|
761
|
+
}, {
|
|
762
|
+
readonly reason: "ambiguous_company";
|
|
763
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
764
|
+
readonly when: "The company input resolves to multiple entities and the target is ambiguous";
|
|
765
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK from the matches list for an exact match.";
|
|
1028
766
|
}, {
|
|
1029
767
|
readonly reason: "no_filings_found";
|
|
1030
768
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
@@ -1075,7 +813,114 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1075
813
|
filer_cik: import("zod").ZodString;
|
|
1076
814
|
accession_number: import("zod").ZodString;
|
|
1077
815
|
filing_date: import("zod").ZodString;
|
|
1078
|
-
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
816
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
817
|
+
}, import("zod/v4/core").$strip>>;
|
|
818
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
819
|
+
name: import("zod").ZodString;
|
|
820
|
+
row_count: import("zod").ZodNumber;
|
|
821
|
+
expires_at: import("zod").ZodString;
|
|
822
|
+
truncated: import("zod").ZodBoolean;
|
|
823
|
+
}, import("zod/v4/core").$strip>>;
|
|
824
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
825
|
+
readonly reason: "issuer_not_found";
|
|
826
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
827
|
+
readonly when: "No cusip was given and the issuer does not resolve to a known EDGAR company";
|
|
828
|
+
readonly recovery: "Confirm the issuer with secedgar_company_search, or pass the cusip parameter to search the information tables directly.";
|
|
829
|
+
}, {
|
|
830
|
+
readonly reason: "ambiguous_issuer";
|
|
831
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
832
|
+
readonly when: "The issuer name matches several EDGAR companies and no cusip was given";
|
|
833
|
+
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
834
|
+
}, {
|
|
835
|
+
readonly reason: "rate_limited";
|
|
836
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
837
|
+
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";
|
|
838
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
839
|
+
readonly retryable: true;
|
|
840
|
+
readonly thrownBy: "service";
|
|
841
|
+
}, {
|
|
842
|
+
readonly reason: "sec_unreachable";
|
|
843
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
844
|
+
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";
|
|
845
|
+
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.";
|
|
846
|
+
readonly retryable: true;
|
|
847
|
+
readonly thrownBy: "service";
|
|
848
|
+
}, {
|
|
849
|
+
readonly reason: "efts_degraded_response";
|
|
850
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
851
|
+
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";
|
|
852
|
+
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
853
|
+
readonly retryable: true;
|
|
854
|
+
readonly thrownBy: "service";
|
|
855
|
+
}], {
|
|
856
|
+
readonly ordering: import("zod").ZodString;
|
|
857
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
858
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
859
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
860
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
861
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
862
|
+
issuer: import("zod").ZodString;
|
|
863
|
+
form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
864
|
+
"13D": "13D";
|
|
865
|
+
"13G": "13G";
|
|
866
|
+
all: "all";
|
|
867
|
+
}>>;
|
|
868
|
+
include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
869
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
870
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
871
|
+
issuer: import("zod").ZodString;
|
|
872
|
+
issuer_cik: import("zod").ZodString;
|
|
873
|
+
issuer_name: import("zod").ZodString;
|
|
874
|
+
form_kind: import("zod").ZodEnum<{
|
|
875
|
+
"13D": "13D";
|
|
876
|
+
"13G": "13G";
|
|
877
|
+
all: "all";
|
|
878
|
+
}>;
|
|
879
|
+
total_structured_filings: import("zod").ZodNumber;
|
|
880
|
+
filings_parsed: import("zod").ZodNumber;
|
|
881
|
+
filings_examined: import("zod").ZodNumber;
|
|
882
|
+
filings_excluded_other_issuer: import("zod").ZodNumber;
|
|
883
|
+
filings_not_examined: import("zod").ZodNumber;
|
|
884
|
+
filings_failed: import("zod").ZodArray<import("zod").ZodObject<{
|
|
885
|
+
accession_number: import("zod").ZodString;
|
|
886
|
+
reason: import("zod").ZodEnum<{
|
|
887
|
+
document_not_found: "document_not_found";
|
|
888
|
+
unparseable: "unparseable";
|
|
889
|
+
}>;
|
|
890
|
+
}, import("zod/v4/core").$strip>>;
|
|
891
|
+
partial: import("zod").ZodBoolean;
|
|
892
|
+
structured_coverage_from: import("zod").ZodString;
|
|
893
|
+
legacy_filings_before_coverage: import("zod").ZodNumber;
|
|
894
|
+
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
895
|
+
form: import("zod").ZodString;
|
|
896
|
+
schedule: import("zod").ZodEnum<{
|
|
897
|
+
"13D": "13D";
|
|
898
|
+
"13G": "13G";
|
|
899
|
+
}>;
|
|
900
|
+
is_amendment: import("zod").ZodBoolean;
|
|
901
|
+
amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
|
|
902
|
+
accession_number: import("zod").ZodString;
|
|
903
|
+
filing_date: import("zod").ZodString;
|
|
904
|
+
event_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
905
|
+
security_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
906
|
+
cusips: import("zod").ZodArray<import("zod").ZodString>;
|
|
907
|
+
purpose_of_transaction: import("zod").ZodOptional<import("zod").ZodString>;
|
|
908
|
+
purpose_truncated: import("zod").ZodBoolean;
|
|
909
|
+
reporting_persons: import("zod").ZodArray<import("zod").ZodObject<{
|
|
910
|
+
name: import("zod").ZodString;
|
|
911
|
+
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
912
|
+
citizenship: import("zod").ZodOptional<import("zod").ZodString>;
|
|
913
|
+
percent_of_class: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
914
|
+
aggregate_amount_owned: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
915
|
+
sole_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
916
|
+
shared_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
917
|
+
sole_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
918
|
+
shared_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
919
|
+
person_types: import("zod").ZodArray<import("zod").ZodString>;
|
|
920
|
+
excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
921
|
+
notes: import("zod").ZodOptional<import("zod").ZodString>;
|
|
922
|
+
notes_truncated: import("zod").ZodBoolean;
|
|
923
|
+
}, import("zod/v4/core").$strip>>;
|
|
1079
924
|
}, import("zod/v4/core").$strip>>;
|
|
1080
925
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1081
926
|
name: import("zod").ZodString;
|
|
@@ -1086,13 +931,18 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1086
931
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1087
932
|
readonly reason: "issuer_not_found";
|
|
1088
933
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1089
|
-
readonly when: "
|
|
1090
|
-
readonly recovery: "
|
|
934
|
+
readonly when: "The issuer input does not resolve to a known EDGAR company";
|
|
935
|
+
readonly recovery: "Use secedgar_company_search to find the issuer ticker or 10-digit CIK.";
|
|
1091
936
|
}, {
|
|
1092
937
|
readonly reason: "ambiguous_issuer";
|
|
1093
938
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1094
|
-
readonly when: "The issuer name matches several EDGAR companies
|
|
939
|
+
readonly when: "The issuer name matches several EDGAR companies";
|
|
1095
940
|
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
941
|
+
}, {
|
|
942
|
+
readonly reason: "no_filings_found";
|
|
943
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
944
|
+
readonly when: "The issuer has no structured SCHEDULE 13D/13G filings matching the requested form kind";
|
|
945
|
+
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.";
|
|
1096
946
|
}, {
|
|
1097
947
|
readonly reason: "rate_limited";
|
|
1098
948
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1107,15 +957,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1107
957
|
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.";
|
|
1108
958
|
readonly retryable: true;
|
|
1109
959
|
readonly thrownBy: "service";
|
|
1110
|
-
}, {
|
|
1111
|
-
readonly reason: "efts_degraded_response";
|
|
1112
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
1113
|
-
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";
|
|
1114
|
-
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
1115
|
-
readonly retryable: true;
|
|
1116
|
-
readonly thrownBy: "service";
|
|
1117
960
|
}], {
|
|
1118
|
-
readonly ordering: import("zod").ZodString;
|
|
1119
961
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1120
962
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1121
963
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -1208,6 +1050,198 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1208
1050
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1209
1051
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1210
1052
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1053
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1054
|
+
concept: import("zod").ZodString;
|
|
1055
|
+
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
1056
|
+
dei: "dei";
|
|
1057
|
+
"us-gaap": "us-gaap";
|
|
1058
|
+
}>>;
|
|
1059
|
+
period: import("zod").ZodString;
|
|
1060
|
+
unit: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
1061
|
+
USD: "USD";
|
|
1062
|
+
"USD-per-shares": "USD-per-shares";
|
|
1063
|
+
"USD/shares": "USD/shares";
|
|
1064
|
+
pure: "pure";
|
|
1065
|
+
shares: "shares";
|
|
1066
|
+
}>>;
|
|
1067
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1068
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1069
|
+
sort: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
1070
|
+
asc: "asc";
|
|
1071
|
+
desc: "desc";
|
|
1072
|
+
}>>;
|
|
1073
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1074
|
+
concept: import("zod").ZodString;
|
|
1075
|
+
taxonomy: import("zod").ZodString;
|
|
1076
|
+
period: import("zod").ZodString;
|
|
1077
|
+
unit: import("zod").ZodString;
|
|
1078
|
+
label: import("zod").ZodString;
|
|
1079
|
+
total_companies: import("zod").ZodNumber;
|
|
1080
|
+
offset: import("zod").ZodNumber;
|
|
1081
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1082
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1083
|
+
rank: import("zod").ZodNumber;
|
|
1084
|
+
company_name: import("zod").ZodString;
|
|
1085
|
+
cik: import("zod").ZodString;
|
|
1086
|
+
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1087
|
+
value: import("zod").ZodNumber;
|
|
1088
|
+
location: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1089
|
+
period_end: import("zod").ZodString;
|
|
1090
|
+
accession_number: import("zod").ZodString;
|
|
1091
|
+
}, import("zod/v4/core").$strip>>;
|
|
1092
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1093
|
+
name: import("zod").ZodString;
|
|
1094
|
+
row_count: import("zod").ZodNumber;
|
|
1095
|
+
expires_at: import("zod").ZodString;
|
|
1096
|
+
}, import("zod/v4/core").$strip>>;
|
|
1097
|
+
unqueried_tags: import("zod").ZodArray<import("zod").ZodString>;
|
|
1098
|
+
related_tags: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1099
|
+
tag: import("zod").ZodString;
|
|
1100
|
+
note: import("zod").ZodString;
|
|
1101
|
+
}, import("zod/v4/core").$strip>>;
|
|
1102
|
+
value_distribution: import("zod").ZodObject<{
|
|
1103
|
+
median: import("zod").ZodNumber;
|
|
1104
|
+
p95: import("zod").ZodNumber;
|
|
1105
|
+
max: import("zod").ZodNumber;
|
|
1106
|
+
max_to_p95_ratio: import("zod").ZodNumber;
|
|
1107
|
+
}, import("zod/v4/core").$strip>;
|
|
1108
|
+
period_end_range: import("zod").ZodObject<{
|
|
1109
|
+
min: import("zod").ZodString;
|
|
1110
|
+
max: import("zod").ZodString;
|
|
1111
|
+
}, import("zod/v4/core").$strip>;
|
|
1112
|
+
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
1113
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
1114
|
+
readonly reason: "unknown_concept";
|
|
1115
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1116
|
+
readonly when: "The concept input is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
|
|
1117
|
+
readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
|
|
1118
|
+
}, {
|
|
1119
|
+
readonly reason: "no_data";
|
|
1120
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1121
|
+
readonly when: "Concept resolves but no companies report the tag this call read for the requested period and unit";
|
|
1122
|
+
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.";
|
|
1123
|
+
}, {
|
|
1124
|
+
readonly reason: "rate_limited";
|
|
1125
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
1126
|
+
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";
|
|
1127
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
1128
|
+
readonly retryable: true;
|
|
1129
|
+
readonly thrownBy: "service";
|
|
1130
|
+
}, {
|
|
1131
|
+
readonly reason: "sec_unreachable";
|
|
1132
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
1133
|
+
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";
|
|
1134
|
+
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.";
|
|
1135
|
+
readonly retryable: true;
|
|
1136
|
+
readonly thrownBy: "service";
|
|
1137
|
+
}], {
|
|
1138
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1139
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1140
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1141
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1142
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1143
|
+
companies: import("zod").ZodArray<import("zod").ZodString>;
|
|
1144
|
+
concepts: import("zod").ZodArray<import("zod").ZodString>;
|
|
1145
|
+
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
1146
|
+
"ifrs-full": "ifrs-full";
|
|
1147
|
+
"us-gaap": "us-gaap";
|
|
1148
|
+
}>>;
|
|
1149
|
+
period_type: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
1150
|
+
annual: "annual";
|
|
1151
|
+
quarterly: "quarterly";
|
|
1152
|
+
}>>;
|
|
1153
|
+
periods: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1154
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1155
|
+
period_type: import("zod").ZodString;
|
|
1156
|
+
taxonomy: import("zod").ZodString;
|
|
1157
|
+
periods: import("zod").ZodArray<import("zod").ZodString>;
|
|
1158
|
+
companies: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1159
|
+
input: import("zod").ZodString;
|
|
1160
|
+
cik: import("zod").ZodString;
|
|
1161
|
+
name: import("zod").ZodString;
|
|
1162
|
+
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1163
|
+
}, import("zod/v4/core").$strip>>;
|
|
1164
|
+
failed_companies: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1165
|
+
input: import("zod").ZodString;
|
|
1166
|
+
reason: import("zod").ZodEnum<{
|
|
1167
|
+
ambiguous: "ambiguous";
|
|
1168
|
+
no_company_facts: "no_company_facts";
|
|
1169
|
+
not_found: "not_found";
|
|
1170
|
+
}>;
|
|
1171
|
+
message: import("zod").ZodString;
|
|
1172
|
+
}, import("zod/v4/core").$strip>>;
|
|
1173
|
+
deferred_companies: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
1174
|
+
concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1175
|
+
concept: import("zod").ZodString;
|
|
1176
|
+
label: import("zod").ZodString;
|
|
1177
|
+
units: import("zod").ZodArray<import("zod").ZodString>;
|
|
1178
|
+
}, import("zod/v4/core").$strip>>;
|
|
1179
|
+
cells: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1180
|
+
cik: import("zod").ZodString;
|
|
1181
|
+
company: import("zod").ZodString;
|
|
1182
|
+
concept: import("zod").ZodString;
|
|
1183
|
+
period: import("zod").ZodString;
|
|
1184
|
+
value: import("zod").ZodNumber;
|
|
1185
|
+
unit: import("zod").ZodString;
|
|
1186
|
+
taxonomy: import("zod").ZodString;
|
|
1187
|
+
tag: import("zod").ZodString;
|
|
1188
|
+
frame: import("zod").ZodString;
|
|
1189
|
+
period_end: import("zod").ZodString;
|
|
1190
|
+
form: import("zod").ZodString;
|
|
1191
|
+
accession_number: import("zod").ZodString;
|
|
1192
|
+
}, import("zod/v4/core").$strip>>;
|
|
1193
|
+
gaps: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1194
|
+
cik: import("zod").ZodString;
|
|
1195
|
+
company: import("zod").ZodString;
|
|
1196
|
+
concept: import("zod").ZodString;
|
|
1197
|
+
tags_tried: import("zod").ZodArray<import("zod").ZodString>;
|
|
1198
|
+
}, import("zod/v4/core").$strip>>;
|
|
1199
|
+
unknown_concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1200
|
+
concept: import("zod").ZodString;
|
|
1201
|
+
derivation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1202
|
+
suggestions: import("zod").ZodArray<import("zod").ZodString>;
|
|
1203
|
+
}, import("zod/v4/core").$strip>>;
|
|
1204
|
+
deferred_concepts: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
1205
|
+
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
1206
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1207
|
+
name: import("zod").ZodString;
|
|
1208
|
+
row_count: import("zod").ZodNumber;
|
|
1209
|
+
expires_at: import("zod").ZodString;
|
|
1210
|
+
}, import("zod/v4/core").$strip>>;
|
|
1211
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
1212
|
+
readonly reason: "no_companies_resolved";
|
|
1213
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1214
|
+
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";
|
|
1215
|
+
readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
|
|
1216
|
+
}, {
|
|
1217
|
+
readonly reason: "no_comparable_data";
|
|
1218
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1219
|
+
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";
|
|
1220
|
+
readonly recovery: "Switch period_type, or discover reported concept names with secedgar_search_concepts.";
|
|
1221
|
+
}, {
|
|
1222
|
+
readonly reason: "unknown_concept";
|
|
1223
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1224
|
+
readonly when: "Every requested concept is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
|
|
1225
|
+
readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
|
|
1226
|
+
}, {
|
|
1227
|
+
readonly reason: "rate_limited";
|
|
1228
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
1229
|
+
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";
|
|
1230
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
1231
|
+
readonly retryable: true;
|
|
1232
|
+
readonly thrownBy: "service";
|
|
1233
|
+
}, {
|
|
1234
|
+
readonly reason: "sec_unreachable";
|
|
1235
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
1236
|
+
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";
|
|
1237
|
+
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.";
|
|
1238
|
+
readonly retryable: true;
|
|
1239
|
+
readonly thrownBy: "service";
|
|
1240
|
+
}], {
|
|
1241
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1242
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1243
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1244
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1211
1245
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1212
1246
|
search: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1213
1247
|
group: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
@@ -1250,29 +1284,6 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1250
1284
|
}, import("zod/v4/core").$strip>, undefined, {
|
|
1251
1285
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1252
1286
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1253
|
-
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1254
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1255
|
-
dataframes: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1256
|
-
name: import("zod").ZodString;
|
|
1257
|
-
source_tool: import("zod").ZodString;
|
|
1258
|
-
query_params: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
|
|
1259
|
-
created_at: import("zod").ZodString;
|
|
1260
|
-
expires_at: import("zod").ZodString;
|
|
1261
|
-
row_count: import("zod").ZodNumber;
|
|
1262
|
-
truncated: import("zod").ZodBoolean;
|
|
1263
|
-
max_rows: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1264
|
-
column_schema: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1265
|
-
name: import("zod").ZodString;
|
|
1266
|
-
type: import("zod").ZodString;
|
|
1267
|
-
nullable: import("zod").ZodBoolean;
|
|
1268
|
-
}, import("zod/v4/core").$strip>>;
|
|
1269
|
-
}, import("zod/v4/core").$strip>>;
|
|
1270
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
1271
|
-
readonly reason: "canvas_unavailable";
|
|
1272
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
1273
|
-
readonly when: "The DataCanvas service is not configured for this deployment";
|
|
1274
|
-
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.";
|
|
1275
|
-
}], undefined> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1276
1287
|
sql: import("zod").ZodString;
|
|
1277
1288
|
register_as: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1278
1289
|
preview: import("zod").ZodOptional<import("zod").ZodNumber>;
|