@cyanheads/secedgar-mcp-server 0.17.0 → 0.17.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 +18 -15
- package/CLAUDE.md +18 -15
- package/README.md +12 -9
- package/changelog/0.17.x/0.17.1.md +36 -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/definitions/company-search.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/company-search.tool.js +6 -4
- 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 +169 -39
- package/dist/mcp-server/tools/definitions/compare-companies.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 +24 -8
- 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 +34 -7
- 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 +146 -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 +305 -81
- package/dist/mcp-server/tools/definitions/get-filing.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 +8 -0
- 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 +3 -1
- package/dist/mcp-server/tools/definitions/get-material-events.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/index.d.ts +453 -423
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-filings.tool.d.ts +33 -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 +31 -2
- package/dist/mcp-server/tools/definitions/search-filings.tool.js.map +1 -1
- 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 +75 -11
- package/dist/services/edgar/edgar-api-service.d.ts.map +1 -1
- package/dist/services/edgar/edgar-api-service.js +273 -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
|
@@ -60,6 +60,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
60
60
|
}>;
|
|
61
61
|
message: import("zod").ZodString;
|
|
62
62
|
}, import("zod/v4/core").$strip>>;
|
|
63
|
+
deferred_companies: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
63
64
|
concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
64
65
|
concept: import("zod").ZodString;
|
|
65
66
|
label: import("zod").ZodString;
|
|
@@ -90,6 +91,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
90
91
|
derivation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
91
92
|
suggestions: import("zod").ZodArray<import("zod").ZodString>;
|
|
92
93
|
}, import("zod/v4/core").$strip>>;
|
|
94
|
+
deferred_concepts: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
93
95
|
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
94
96
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
95
97
|
name: import("zod").ZodString;
|
|
@@ -99,12 +101,12 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
99
101
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
100
102
|
readonly reason: "no_companies_resolved";
|
|
101
103
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
102
|
-
readonly when: "None of the
|
|
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";
|
|
103
105
|
readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
|
|
104
106
|
}, {
|
|
105
107
|
readonly reason: "no_comparable_data";
|
|
106
108
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
107
|
-
readonly when: "Companies resolved but not one of them reports any of the requested concepts for the requested period type";
|
|
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";
|
|
108
110
|
readonly recovery: "Switch period_type, or discover reported concept names with secedgar_search_concepts.";
|
|
109
111
|
}, {
|
|
110
112
|
readonly reason: "unknown_concept";
|
|
@@ -198,8 +200,8 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
198
200
|
}, {
|
|
199
201
|
readonly reason: "no_data";
|
|
200
202
|
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
|
|
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.";
|
|
203
205
|
}, {
|
|
204
206
|
readonly reason: "rate_limited";
|
|
205
207
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -219,6 +221,117 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
219
221
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
220
222
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
221
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
|
+
}>>;
|
|
236
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
237
|
+
total: import("zod").ZodNumber;
|
|
238
|
+
total_is_exact: import("zod").ZodBoolean;
|
|
239
|
+
total_documents: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
240
|
+
results: import("zod").ZodArray<import("zod").ZodObject<{
|
|
241
|
+
accession_number: import("zod").ZodString;
|
|
242
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
243
|
+
filing_date: import("zod").ZodString;
|
|
244
|
+
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
245
|
+
company_name: import("zod").ZodString;
|
|
246
|
+
cik: import("zod").ZodString;
|
|
247
|
+
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
248
|
+
file_description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
249
|
+
matched_documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
250
|
+
name: import("zod").ZodString;
|
|
251
|
+
type: import("zod").ZodOptional<import("zod").ZodString>;
|
|
252
|
+
}, import("zod/v4/core").$strip>>>;
|
|
253
|
+
sic: import("zod").ZodOptional<import("zod").ZodString>;
|
|
254
|
+
location: import("zod").ZodOptional<import("zod").ZodString>;
|
|
255
|
+
source: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
256
|
+
efts: "efts";
|
|
257
|
+
"full-index": "full-index";
|
|
258
|
+
submissions: "submissions";
|
|
259
|
+
}>>;
|
|
260
|
+
}, import("zod/v4/core").$strip>>;
|
|
261
|
+
form_distribution: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>>;
|
|
262
|
+
scan: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
263
|
+
candidates: import("zod").ZodNumber;
|
|
264
|
+
scanned: import("zod").ZodNumber;
|
|
265
|
+
matched: import("zod").ZodNumber;
|
|
266
|
+
capped: import("zod").ZodBoolean;
|
|
267
|
+
}, import("zod/v4/core").$strip>>;
|
|
268
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
269
|
+
name: import("zod").ZodString;
|
|
270
|
+
row_count: import("zod").ZodNumber;
|
|
271
|
+
expires_at: import("zod").ZodString;
|
|
272
|
+
truncated: import("zod").ZodBoolean;
|
|
273
|
+
}, import("zod/v4/core").$strip>>;
|
|
274
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
275
|
+
readonly reason: "unresolved_ticker";
|
|
276
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
277
|
+
readonly when: "A ticker: targeting token in the query does not resolve to a known company";
|
|
278
|
+
readonly recovery: "Verify the symbol with secedgar_company_search, or target by CIK with cik:<number> instead.";
|
|
279
|
+
readonly thrownBy: "service";
|
|
280
|
+
}, {
|
|
281
|
+
readonly reason: "invalid_cik";
|
|
282
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
283
|
+
readonly when: "A cik: targeting token in the query is not a 1-10 digit number";
|
|
284
|
+
readonly recovery: "Pass a numeric CIK such as cik:320193 — find it with secedgar_company_search if unknown.";
|
|
285
|
+
readonly thrownBy: "service";
|
|
286
|
+
}, {
|
|
287
|
+
readonly reason: "entity_not_found";
|
|
288
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
289
|
+
readonly when: "A cik: targeting token on a pre-2001 date range names a CIK with no EDGAR submissions history";
|
|
290
|
+
readonly recovery: "Confirm the CIK with secedgar_company_search — an accession-number prefix names the filing agent, not the issuer.";
|
|
291
|
+
readonly thrownBy: "service";
|
|
292
|
+
}, {
|
|
293
|
+
readonly reason: "missing_criteria";
|
|
294
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
295
|
+
readonly when: "Neither a full-text query nor a forms filter was provided (a date range cannot stand alone)";
|
|
296
|
+
readonly recovery: "Provide search terms, or browse by form type (forms: [\"S-1\"]) or entity (ticker:AAPL / cik:320193 in the query) — optionally narrowed by date.";
|
|
297
|
+
}, {
|
|
298
|
+
readonly reason: "pre2001_full_text_unscoped";
|
|
299
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
300
|
+
readonly when: "A date range reaching before 2001-01-01 carries free-text terms with no entity scope — no pre-2001 full-text index exists, and nothing bounds a local scan";
|
|
301
|
+
readonly recovery: "Add ticker: or cik: entity scope to the query, drop the text terms and browse by form type (forms: [\"10-K\"]) and date, or, for a range that reaches 2001, start the range at 2001-01-01.";
|
|
302
|
+
}, {
|
|
303
|
+
readonly reason: "offset_out_of_range";
|
|
304
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
305
|
+
readonly when: "A sort=relevance search with no ticker:/cik: scope and no date range reaching before 2001 asks for an offset above 9900, past the deepest page EDGAR full-text search serves";
|
|
306
|
+
readonly recovery: "Use an offset of 9900 or less — a page there with limit 100 reaches EDGAR's 10,000-document cap — or narrow the search with a shorter filed_after/filed_before window, a forms filter, or more specific terms so fewer documents match.";
|
|
307
|
+
readonly retryable: false;
|
|
308
|
+
}, {
|
|
309
|
+
readonly reason: "rate_limited";
|
|
310
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
311
|
+
readonly when: "SEC is rate-limiting this server's IP — SEC answered 429, or the call was refused without being sent while the cool-down after one runs";
|
|
312
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
313
|
+
readonly retryable: true;
|
|
314
|
+
readonly thrownBy: "service";
|
|
315
|
+
}, {
|
|
316
|
+
readonly reason: "sec_unreachable";
|
|
317
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
318
|
+
readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
|
|
319
|
+
readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
|
|
320
|
+
readonly retryable: true;
|
|
321
|
+
readonly thrownBy: "service";
|
|
322
|
+
}, {
|
|
323
|
+
readonly reason: "efts_degraded_response";
|
|
324
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
325
|
+
readonly when: "EDGAR full-text search answered without results — its search backend failed to run the search on every attempt made (a connection or timeout failure, retried like a request SEC never answered), refused the request (upstreamErrorType and upstreamErrorMessage carry its error, and the request is not retried), or sent a payload with no hit list";
|
|
326
|
+
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
327
|
+
readonly retryable: true;
|
|
328
|
+
readonly thrownBy: "service";
|
|
329
|
+
}], {
|
|
330
|
+
readonly effectiveQuery: import("zod").ZodString;
|
|
331
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
332
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
333
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
334
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
222
335
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
223
336
|
issuer: import("zod").ZodString;
|
|
224
337
|
form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
@@ -280,6 +393,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
280
393
|
person_types: import("zod").ZodArray<import("zod").ZodString>;
|
|
281
394
|
excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
282
395
|
notes: import("zod").ZodOptional<import("zod").ZodString>;
|
|
396
|
+
notes_truncated: import("zod").ZodBoolean;
|
|
283
397
|
}, import("zod/v4/core").$strip>>;
|
|
284
398
|
}, import("zod/v4/core").$strip>>;
|
|
285
399
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
@@ -323,246 +437,100 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
323
437
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
324
438
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
325
439
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
326
|
-
|
|
327
|
-
|
|
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>;
|
|
440
|
+
company: import("zod").ZodString;
|
|
441
|
+
quarter: import("zod").ZodOptional<import("zod").ZodString>;
|
|
434
442
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
435
443
|
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
444
|
+
consolidate: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
436
445
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
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>;
|
|
446
|
+
filer_name: import("zod").ZodString;
|
|
447
|
+
filer_cik: import("zod").ZodString;
|
|
448
|
+
reporting_period: import("zod").ZodOptional<import("zod").ZodString>;
|
|
445
449
|
filing_date: import("zod").ZodString;
|
|
446
|
-
publication_lag_days: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
447
|
-
form: import("zod").ZodString;
|
|
448
450
|
accession_number: import("zod").ZodString;
|
|
449
|
-
|
|
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<{
|
|
451
|
+
amendments: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
535
452
|
accession_number: import("zod").ZodString;
|
|
536
|
-
form: import("zod").ZodString;
|
|
537
453
|
filing_date: import("zod").ZodString;
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
454
|
+
applied_as: import("zod").ZodEnum<{
|
|
455
|
+
new_holdings: "new_holdings";
|
|
456
|
+
not_applied: "not_applied";
|
|
457
|
+
restatement: "restatement";
|
|
458
|
+
superseded: "superseded";
|
|
459
|
+
}>;
|
|
460
|
+
amendment_type: import("zod").ZodEnum<{
|
|
461
|
+
"NEW HOLDINGS": "NEW HOLDINGS";
|
|
462
|
+
RESTATEMENT: "RESTATEMENT";
|
|
463
|
+
}>;
|
|
464
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
465
|
+
accession_number: import("zod").ZodString;
|
|
466
|
+
filing_date: import("zod").ZodString;
|
|
467
|
+
applied_as: import("zod").ZodEnum<{
|
|
468
|
+
new_holdings: "new_holdings";
|
|
469
|
+
not_applied: "not_applied";
|
|
470
|
+
restatement: "restatement";
|
|
471
|
+
superseded: "superseded";
|
|
472
|
+
}>;
|
|
473
|
+
amendment_type: import("zod").ZodLiteral<"UNAVAILABLE">;
|
|
474
|
+
unavailable_reason: import("zod").ZodEnum<{
|
|
475
|
+
lookup_failed: "lookup_failed";
|
|
476
|
+
lookup_stopped: "lookup_stopped";
|
|
477
|
+
missing_header: "missing_header";
|
|
478
|
+
unreadable_header: "unreadable_header";
|
|
479
|
+
}>;
|
|
480
|
+
}, import("zod/v4/core").$strip>], "amendment_type">>>;
|
|
481
|
+
amendment_search_complete: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
482
|
+
composed_accessions: import("zod").ZodArray<import("zod").ZodString>;
|
|
483
|
+
total_holdings_in_filing: import("zod").ZodNumber;
|
|
484
|
+
total_holdings_composed: import("zod").ZodNumber;
|
|
485
|
+
total_positions: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
486
|
+
offset: import("zod").ZodNumber;
|
|
487
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
488
|
+
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
489
|
+
issuer_name: import("zod").ZodString;
|
|
490
|
+
title_of_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
491
|
+
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
492
|
+
market_value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
493
|
+
shares_or_principal_amount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
494
|
+
shares_or_principal_type: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
495
|
+
PRN: "PRN";
|
|
496
|
+
SH: "SH";
|
|
497
|
+
}>>;
|
|
498
|
+
put_call: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
499
|
+
Call: "Call";
|
|
500
|
+
Put: "Put";
|
|
501
|
+
}>>;
|
|
502
|
+
investment_discretion: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
503
|
+
DFND: "DFND";
|
|
504
|
+
OTR: "OTR";
|
|
505
|
+
SOLE: "SOLE";
|
|
506
|
+
}>>;
|
|
507
|
+
source_accession_numbers: import("zod").ZodArray<import("zod").ZodString>;
|
|
549
508
|
}, import("zod/v4/core").$strip>>;
|
|
550
509
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
551
510
|
name: import("zod").ZodString;
|
|
552
511
|
row_count: import("zod").ZodNumber;
|
|
553
512
|
expires_at: import("zod").ZodString;
|
|
554
|
-
truncated: import("zod").ZodBoolean;
|
|
555
513
|
}, import("zod/v4/core").$strip>>;
|
|
556
514
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
557
|
-
readonly reason: "
|
|
515
|
+
readonly reason: "company_not_found";
|
|
558
516
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
559
|
-
readonly when: "
|
|
560
|
-
readonly recovery: "Use
|
|
517
|
+
readonly when: "The company input does not resolve to a known company or institution";
|
|
518
|
+
readonly recovery: "Use secedgar_company_search to find the correct CIK or full entity name.";
|
|
561
519
|
}, {
|
|
562
|
-
readonly reason: "
|
|
520
|
+
readonly reason: "ambiguous_entity";
|
|
521
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
522
|
+
readonly when: "The name resolves to multiple EDGAR entities (e.g. several filers sharing a legal name)";
|
|
523
|
+
readonly recovery: "Retry with the exact 10-digit CIK of the intended filer from the matches list.";
|
|
524
|
+
}, {
|
|
525
|
+
readonly reason: "no_filings_found";
|
|
563
526
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
564
|
-
readonly when: "
|
|
565
|
-
readonly recovery: "
|
|
527
|
+
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)";
|
|
528
|
+
readonly recovery: "Use secedgar_search_filings with forms=[\"13F-HR\"] for broader search, or check that the entity is an institutional investment manager.";
|
|
529
|
+
}, {
|
|
530
|
+
readonly reason: "no_info_table";
|
|
531
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
532
|
+
readonly when: "The 13F-HR filing was found but the information table XML document could not be located";
|
|
533
|
+
readonly recovery: "Use secedgar_get_filing with the accession number to inspect the filing documents directly.";
|
|
566
534
|
}, {
|
|
567
535
|
readonly reason: "rate_limited";
|
|
568
536
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -577,6 +545,13 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
577
545
|
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
546
|
readonly retryable: true;
|
|
579
547
|
readonly thrownBy: "service";
|
|
548
|
+
}, {
|
|
549
|
+
readonly reason: "efts_degraded_response";
|
|
550
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
551
|
+
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";
|
|
552
|
+
readonly recovery: "Retry the same call in a minute unless the error is marked not retryable; then change the request as upstreamErrorMessage indicates.";
|
|
553
|
+
readonly retryable: true;
|
|
554
|
+
readonly thrownBy: "service";
|
|
580
555
|
}], {
|
|
581
556
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
582
557
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
@@ -646,83 +621,91 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
646
621
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
647
622
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
648
623
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
624
|
+
accession_number: import("zod").ZodString;
|
|
625
|
+
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
626
|
+
content_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
627
|
+
document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
628
|
+
include_xbrl: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
654
629
|
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
655
|
-
|
|
656
|
-
filing_date_asc: "filing_date_asc";
|
|
657
|
-
filing_date_desc: "filing_date_desc";
|
|
658
|
-
relevance: "relevance";
|
|
659
|
-
}>>;
|
|
630
|
+
section: import("zod").ZodOptional<import("zod").ZodString>;
|
|
660
631
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
672
|
-
file_description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
673
|
-
matched_documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
632
|
+
accession_number: import("zod").ZodString;
|
|
633
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
634
|
+
filing_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
635
|
+
company_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
636
|
+
cik: import("zod").ZodString;
|
|
637
|
+
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
638
|
+
primary_document: import("zod").ZodString;
|
|
639
|
+
requested_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
640
|
+
documents: import("zod").ZodObject<{
|
|
641
|
+
primary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
674
642
|
name: import("zod").ZodString;
|
|
675
|
-
type: import("zod").
|
|
643
|
+
type: import("zod").ZodString;
|
|
644
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
645
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
646
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
647
|
+
}, import("zod/v4/core").$strip>>;
|
|
648
|
+
exhibits: import("zod").ZodArray<import("zod").ZodObject<{
|
|
649
|
+
name: import("zod").ZodString;
|
|
650
|
+
type: import("zod").ZodString;
|
|
651
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
652
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
653
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
654
|
+
}, import("zod/v4/core").$strip>>;
|
|
655
|
+
auxiliary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
656
|
+
name: import("zod").ZodString;
|
|
657
|
+
type: import("zod").ZodString;
|
|
658
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
659
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
660
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
661
|
+
}, import("zod/v4/core").$strip>>;
|
|
662
|
+
xbrl: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
663
|
+
name: import("zod").ZodString;
|
|
664
|
+
type: import("zod").ZodString;
|
|
665
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
666
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
667
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
676
668
|
}, import("zod/v4/core").$strip>>>;
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
candidates: import("zod").ZodNumber;
|
|
688
|
-
scanned: import("zod").ZodNumber;
|
|
689
|
-
matched: import("zod").ZodNumber;
|
|
690
|
-
capped: import("zod").ZodBoolean;
|
|
691
|
-
}, import("zod/v4/core").$strip>>;
|
|
692
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
693
|
-
name: import("zod").ZodString;
|
|
694
|
-
row_count: import("zod").ZodNumber;
|
|
695
|
-
expires_at: import("zod").ZodString;
|
|
696
|
-
truncated: import("zod").ZodBoolean;
|
|
697
|
-
}, import("zod/v4/core").$strip>>;
|
|
669
|
+
}, import("zod/v4/core").$strip>;
|
|
670
|
+
content: import("zod").ZodString;
|
|
671
|
+
content_truncated: import("zod").ZodBoolean;
|
|
672
|
+
content_total_length: import("zod").ZodNumber;
|
|
673
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
674
|
+
outline: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
675
|
+
heading: import("zod").ZodString;
|
|
676
|
+
offset: import("zod").ZodNumber;
|
|
677
|
+
}, import("zod/v4/core").$strip>>>;
|
|
678
|
+
filing_url: import("zod").ZodString;
|
|
698
679
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
699
|
-
readonly reason: "
|
|
700
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
701
|
-
readonly when: "A
|
|
702
|
-
readonly recovery: "
|
|
703
|
-
readonly thrownBy: "service";
|
|
680
|
+
readonly reason: "document_not_found";
|
|
681
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
682
|
+
readonly when: "A specific document was requested but not present in the filing archive";
|
|
683
|
+
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.";
|
|
704
684
|
}, {
|
|
705
|
-
readonly reason: "
|
|
685
|
+
readonly reason: "no_documents";
|
|
686
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
687
|
+
readonly when: "Filing index lists items but no fetchable primary document was found";
|
|
688
|
+
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.";
|
|
689
|
+
}, {
|
|
690
|
+
readonly reason: "binary_document";
|
|
706
691
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
707
|
-
readonly when: "
|
|
708
|
-
readonly recovery: "
|
|
709
|
-
readonly thrownBy: "service";
|
|
692
|
+
readonly when: "The requested document is a binary entry (scanned image, PDF, archive) with no text to return";
|
|
693
|
+
readonly recovery: "Pick a text document (.htm, .txt, .xml) from the list in the error message.";
|
|
710
694
|
}, {
|
|
711
|
-
readonly reason: "
|
|
695
|
+
readonly reason: "filing_not_found";
|
|
712
696
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
713
|
-
readonly when: "
|
|
714
|
-
readonly recovery: "
|
|
715
|
-
readonly thrownBy: "service";
|
|
697
|
+
readonly when: "No filing matches the accession number under any candidate CIK";
|
|
698
|
+
readonly recovery: "Verify the accession number and pass the company CIK explicitly.";
|
|
716
699
|
}, {
|
|
717
|
-
readonly reason: "
|
|
700
|
+
readonly reason: "offset_out_of_range";
|
|
718
701
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
719
|
-
readonly when: "
|
|
720
|
-
readonly recovery: "
|
|
702
|
+
readonly when: "The provided offset is at or beyond the end of the document";
|
|
703
|
+
readonly recovery: "Use an offset less than the total document length shown in the error message.";
|
|
721
704
|
}, {
|
|
722
|
-
readonly reason: "
|
|
723
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
724
|
-
readonly when: "
|
|
725
|
-
readonly recovery: "
|
|
705
|
+
readonly reason: "section_not_found";
|
|
706
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
707
|
+
readonly when: "The section string matched no detected heading and no line of the document";
|
|
708
|
+
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
709
|
}, {
|
|
727
710
|
readonly reason: "rate_limited";
|
|
728
711
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -738,7 +721,6 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
738
721
|
readonly retryable: true;
|
|
739
722
|
readonly thrownBy: "service";
|
|
740
723
|
}], {
|
|
741
|
-
readonly effectiveQuery: import("zod").ZodString;
|
|
742
724
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
743
725
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
744
726
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -888,28 +870,90 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
888
870
|
tag: import("zod").ZodString;
|
|
889
871
|
}, import("zod/v4/core").$strip>>;
|
|
890
872
|
}, import("zod/v4/core").$strip>>;
|
|
891
|
-
gaps: import("zod").ZodArray<import("zod").ZodObject<{
|
|
892
|
-
concept: import("zod").ZodString;
|
|
893
|
-
label: import("zod").ZodString;
|
|
894
|
-
group: import("zod").ZodString;
|
|
895
|
-
tags_tried: import("zod").ZodArray<import("zod").ZodString>;
|
|
873
|
+
gaps: import("zod").ZodArray<import("zod").ZodObject<{
|
|
874
|
+
concept: import("zod").ZodString;
|
|
875
|
+
label: import("zod").ZodString;
|
|
876
|
+
group: import("zod").ZodString;
|
|
877
|
+
tags_tried: import("zod").ZodArray<import("zod").ZodString>;
|
|
878
|
+
}, import("zod/v4/core").$strip>>;
|
|
879
|
+
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
880
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
881
|
+
readonly reason: "company_not_found";
|
|
882
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
883
|
+
readonly when: "The company input does not resolve to a CIK";
|
|
884
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK number for an exact match.";
|
|
885
|
+
}, {
|
|
886
|
+
readonly reason: "ambiguous_company";
|
|
887
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
888
|
+
readonly when: "The company input resolves to multiple entities and the target is ambiguous";
|
|
889
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK from the matches list for an exact match.";
|
|
890
|
+
}, {
|
|
891
|
+
readonly reason: "no_company_facts";
|
|
892
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
893
|
+
readonly when: "The filer has no XBRL facts at all — pre-XBRL, foreign private issuer, or a non-operating registrant";
|
|
894
|
+
readonly recovery: "Check the filer files XBRL financial statements, or read the filings directly with secedgar_search_filings.";
|
|
895
|
+
}, {
|
|
896
|
+
readonly reason: "rate_limited";
|
|
897
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
898
|
+
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";
|
|
899
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
900
|
+
readonly retryable: true;
|
|
901
|
+
readonly thrownBy: "service";
|
|
902
|
+
}, {
|
|
903
|
+
readonly reason: "sec_unreachable";
|
|
904
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
905
|
+
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";
|
|
906
|
+
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.";
|
|
907
|
+
readonly retryable: true;
|
|
908
|
+
readonly thrownBy: "service";
|
|
909
|
+
}], undefined> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
910
|
+
company: import("zod").ZodString;
|
|
911
|
+
items: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodEnum<{
|
|
912
|
+
[x: string]: string;
|
|
913
|
+
}>>>;
|
|
914
|
+
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
915
|
+
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
916
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
917
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
918
|
+
cik: import("zod").ZodString;
|
|
919
|
+
company_name: import("zod").ZodString;
|
|
920
|
+
items_filter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
921
|
+
total_matched: import("zod").ZodNumber;
|
|
922
|
+
total_8k_scanned: import("zod").ZodNumber;
|
|
923
|
+
item_distribution: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodNumber>;
|
|
924
|
+
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
925
|
+
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
926
|
+
accession_number: import("zod").ZodString;
|
|
927
|
+
form: import("zod").ZodString;
|
|
928
|
+
filing_date: import("zod").ZodString;
|
|
929
|
+
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
930
|
+
primary_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
931
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
932
|
+
items: import("zod").ZodArray<import("zod").ZodObject<{
|
|
933
|
+
code: import("zod").ZodString;
|
|
934
|
+
label: import("zod").ZodOptional<import("zod").ZodString>;
|
|
935
|
+
regime: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
936
|
+
current: "current";
|
|
937
|
+
legacy: "legacy";
|
|
938
|
+
}>>;
|
|
939
|
+
}, import("zod/v4/core").$strip>>;
|
|
940
|
+
}, import("zod/v4/core").$strip>>;
|
|
941
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
942
|
+
name: import("zod").ZodString;
|
|
943
|
+
row_count: import("zod").ZodNumber;
|
|
944
|
+
expires_at: import("zod").ZodString;
|
|
945
|
+
truncated: import("zod").ZodBoolean;
|
|
896
946
|
}, import("zod/v4/core").$strip>>;
|
|
897
|
-
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
898
947
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
899
|
-
readonly reason: "
|
|
948
|
+
readonly reason: "no_match";
|
|
900
949
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
901
|
-
readonly when: "
|
|
902
|
-
readonly recovery: "Use a ticker symbol or 10-digit CIK
|
|
903
|
-
}, {
|
|
904
|
-
readonly reason: "ambiguous_company";
|
|
905
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
906
|
-
readonly when: "The company input resolves to multiple entities and the target is ambiguous";
|
|
907
|
-
readonly recovery: "Use a ticker symbol or 10-digit CIK from the matches list for an exact match.";
|
|
950
|
+
readonly when: "No company matches the query";
|
|
951
|
+
readonly recovery: "Use a ticker symbol or 10-digit CIK for an exact match, or find the company with secedgar_company_search.";
|
|
908
952
|
}, {
|
|
909
|
-
readonly reason: "
|
|
953
|
+
readonly reason: "multiple_matches";
|
|
910
954
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
911
|
-
readonly when: "The
|
|
912
|
-
readonly recovery: "
|
|
955
|
+
readonly when: "The query is ambiguous and matches several companies";
|
|
956
|
+
readonly recovery: "Retry with a ticker symbol or the 10-digit CIK from the matches list.";
|
|
913
957
|
}, {
|
|
914
958
|
readonly reason: "rate_limited";
|
|
915
959
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -924,7 +968,12 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
924
968
|
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.";
|
|
925
969
|
readonly retryable: true;
|
|
926
970
|
readonly thrownBy: "service";
|
|
927
|
-
}],
|
|
971
|
+
}], {
|
|
972
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
973
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
974
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
975
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
976
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
928
977
|
company: import("zod").ZodString;
|
|
929
978
|
transaction_type: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
930
979
|
all: "all";
|
|
@@ -1001,100 +1050,49 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1001
1050
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1002
1051
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1003
1052
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1004
|
-
|
|
1005
|
-
|
|
1053
|
+
issuer: import("zod").ZodString;
|
|
1054
|
+
cusip: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
1055
|
+
quarter: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
1006
1056
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1007
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1008
|
-
consolidate: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
1009
1057
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1058
|
+
issuer: import("zod").ZodString;
|
|
1059
|
+
resolved_issuer_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1060
|
+
resolved_issuer_cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1061
|
+
search_mode: import("zod").ZodEnum<{
|
|
1062
|
+
cusip: "cusip";
|
|
1063
|
+
name: "name";
|
|
1064
|
+
}>;
|
|
1065
|
+
search_key: import("zod").ZodString;
|
|
1066
|
+
quarter: import("zod").ZodString;
|
|
1067
|
+
filed_from: import("zod").ZodString;
|
|
1068
|
+
filed_to: import("zod").ZodString;
|
|
1069
|
+
total_filings: import("zod").ZodNumber;
|
|
1070
|
+
total_is_exact: import("zod").ZodBoolean;
|
|
1071
|
+
fetched: import("zod").ZodNumber;
|
|
1072
|
+
holders_in_quarter: import("zod").ZodNumber;
|
|
1073
|
+
holders: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1074
|
+
filer_name: import("zod").ZodString;
|
|
1075
|
+
filer_cik: import("zod").ZodString;
|
|
1029
1076
|
accession_number: import("zod").ZodString;
|
|
1030
1077
|
filing_date: import("zod").ZodString;
|
|
1031
|
-
|
|
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>;
|
|
1050
|
-
offset: import("zod").ZodNumber;
|
|
1051
|
-
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1052
|
-
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1053
|
-
issuer_name: import("zod").ZodString;
|
|
1054
|
-
title_of_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1055
|
-
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1056
|
-
market_value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1057
|
-
shares_or_principal_amount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1058
|
-
shares_or_principal_type: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
1059
|
-
PRN: "PRN";
|
|
1060
|
-
SH: "SH";
|
|
1061
|
-
}>>;
|
|
1062
|
-
put_call: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
1063
|
-
Call: "Call";
|
|
1064
|
-
Put: "Put";
|
|
1065
|
-
}>>;
|
|
1066
|
-
investment_discretion: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
1067
|
-
DFND: "DFND";
|
|
1068
|
-
OTR: "OTR";
|
|
1069
|
-
SOLE: "SOLE";
|
|
1070
|
-
}>>;
|
|
1071
|
-
source_accession_numbers: import("zod").ZodArray<import("zod").ZodString>;
|
|
1078
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1072
1079
|
}, import("zod/v4/core").$strip>>;
|
|
1073
1080
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1074
1081
|
name: import("zod").ZodString;
|
|
1075
1082
|
row_count: import("zod").ZodNumber;
|
|
1076
1083
|
expires_at: import("zod").ZodString;
|
|
1084
|
+
truncated: import("zod").ZodBoolean;
|
|
1077
1085
|
}, import("zod/v4/core").$strip>>;
|
|
1078
1086
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1079
|
-
readonly reason: "
|
|
1087
|
+
readonly reason: "issuer_not_found";
|
|
1080
1088
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1081
|
-
readonly when: "
|
|
1082
|
-
readonly recovery: "
|
|
1089
|
+
readonly when: "No cusip was given and the issuer does not resolve to a known EDGAR company";
|
|
1090
|
+
readonly recovery: "Confirm the issuer with secedgar_company_search, or pass the cusip parameter to search the information tables directly.";
|
|
1083
1091
|
}, {
|
|
1084
|
-
readonly reason: "
|
|
1092
|
+
readonly reason: "ambiguous_issuer";
|
|
1085
1093
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1086
|
-
readonly when: "The name
|
|
1087
|
-
readonly recovery: "Retry with the
|
|
1088
|
-
}, {
|
|
1089
|
-
readonly reason: "no_filings_found";
|
|
1090
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1091
|
-
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)";
|
|
1092
|
-
readonly recovery: "Use secedgar_search_filings with forms=[\"13F-HR\"] for broader search, or check that the entity is an institutional investment manager.";
|
|
1093
|
-
}, {
|
|
1094
|
-
readonly reason: "no_info_table";
|
|
1095
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1096
|
-
readonly when: "The 13F-HR filing was found but the information table XML document could not be located";
|
|
1097
|
-
readonly recovery: "Use secedgar_get_filing with the accession number to inspect the filing documents directly.";
|
|
1094
|
+
readonly when: "The issuer name matches several EDGAR companies and no cusip was given";
|
|
1095
|
+
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
1098
1096
|
}, {
|
|
1099
1097
|
readonly reason: "rate_limited";
|
|
1100
1098
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1109,55 +1107,87 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1109
1107
|
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.";
|
|
1110
1108
|
readonly retryable: true;
|
|
1111
1109
|
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";
|
|
1112
1117
|
}], {
|
|
1118
|
+
readonly ordering: import("zod").ZodString;
|
|
1113
1119
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1114
1120
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1115
1121
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1116
1122
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1117
1123
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1124
|
+
fund: import("zod").ZodString;
|
|
1125
|
+
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1126
|
+
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1121
1127
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1128
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1122
1129
|
}, 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
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1130
|
+
fund: import("zod").ZodString;
|
|
1131
|
+
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1132
|
+
series_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1133
|
+
class_ids: import("zod").ZodArray<import("zod").ZodString>;
|
|
1134
|
+
registrant_cik: import("zod").ZodString;
|
|
1135
|
+
registrant_name: import("zod").ZodString;
|
|
1136
|
+
report_period_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1137
|
+
report_period_end: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1138
|
+
filing_date: import("zod").ZodString;
|
|
1139
|
+
publication_lag_days: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1140
|
+
form: import("zod").ZodString;
|
|
1141
|
+
accession_number: import("zod").ZodString;
|
|
1142
|
+
is_final_filing: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1143
|
+
net_assets_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1144
|
+
total_assets_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1145
|
+
total_liabilities_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1146
|
+
total_holdings: import("zod").ZodNumber;
|
|
1147
|
+
offset: import("zod").ZodNumber;
|
|
1148
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1149
|
+
available_report_periods: import("zod").ZodArray<import("zod").ZodString>;
|
|
1150
|
+
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1151
|
+
name: import("zod").ZodString;
|
|
1152
|
+
title: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1153
|
+
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1154
|
+
isin: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1155
|
+
lei: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1156
|
+
balance: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1157
|
+
units: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1158
|
+
currency: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1159
|
+
value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1160
|
+
percent_of_net_assets: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1161
|
+
payoff_profile: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1162
|
+
asset_category: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1163
|
+
issuer_category: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1164
|
+
country: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1144
1165
|
}, import("zod/v4/core").$strip>>;
|
|
1145
1166
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1146
1167
|
name: import("zod").ZodString;
|
|
1147
1168
|
row_count: import("zod").ZodNumber;
|
|
1148
1169
|
expires_at: import("zod").ZodString;
|
|
1149
|
-
truncated: import("zod").ZodBoolean;
|
|
1150
1170
|
}, import("zod/v4/core").$strip>>;
|
|
1151
1171
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1152
|
-
readonly reason: "
|
|
1172
|
+
readonly reason: "fund_not_found";
|
|
1153
1173
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1154
|
-
readonly when: "
|
|
1155
|
-
readonly recovery: "
|
|
1174
|
+
readonly when: "The fund input resolves to neither an EDGAR company nor a known fund series";
|
|
1175
|
+
readonly recovery: "Use secedgar_company_search with the fund ticker to get its CIK and series ID.";
|
|
1156
1176
|
}, {
|
|
1157
|
-
readonly reason: "
|
|
1177
|
+
readonly reason: "ambiguous_fund";
|
|
1158
1178
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1159
|
-
readonly when: "The
|
|
1160
|
-
readonly recovery: "Retry with the ticker or the 10-digit CIK
|
|
1179
|
+
readonly when: "The fund name matches several EDGAR companies";
|
|
1180
|
+
readonly recovery: "Retry with the fund ticker or the 10-digit CIK from the matches list.";
|
|
1181
|
+
}, {
|
|
1182
|
+
readonly reason: "series_required";
|
|
1183
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1184
|
+
readonly when: "The input resolves to a registrant trust that files reports for more than one fund series";
|
|
1185
|
+
readonly recovery: "Retry with series_id set to one of the listed series, or pass a fund ticker.";
|
|
1186
|
+
}, {
|
|
1187
|
+
readonly reason: "no_filings_found";
|
|
1188
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1189
|
+
readonly when: "No NPORT-P report exists for this fund, or none covers the report_date requested";
|
|
1190
|
+
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.";
|
|
1161
1191
|
}, {
|
|
1162
1192
|
readonly reason: "rate_limited";
|
|
1163
1193
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1173,7 +1203,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1173
1203
|
readonly retryable: true;
|
|
1174
1204
|
readonly thrownBy: "service";
|
|
1175
1205
|
}], {
|
|
1176
|
-
readonly
|
|
1206
|
+
readonly as_of: import("zod").ZodString;
|
|
1177
1207
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1178
1208
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1179
1209
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|