@cyanheads/secedgar-mcp-server 0.15.14 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +14 -9
- package/CLAUDE.md +14 -9
- package/README.md +21 -16
- package/changelog/0.15.x/0.15.15.md +24 -0
- package/changelog/0.16.x/0.16.0.md +34 -0
- package/dist/config/server-config.d.ts +14 -0
- package/dist/config/server-config.d.ts.map +1 -1
- package/dist/config/server-config.js +38 -13
- package/dist/config/server-config.js.map +1 -1
- package/dist/index.js +16 -8
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/tools/definitions/company-search.tool.d.ts +66 -0
- package/dist/mcp-server/tools/definitions/company-search.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/company-search.tool.js +24 -13
- package/dist/mcp-server/tools/definitions/company-search.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/compare-companies.tool.d.ts +104 -0
- package/dist/mcp-server/tools/definitions/compare-companies.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/compare-companies.tool.js +21 -11
- package/dist/mcp-server/tools/definitions/compare-companies.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.d.ts +87 -2
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.js +41 -25
- package/dist/mcp-server/tools/definitions/dataframe-query.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.d.ts +92 -0
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.js +20 -4
- package/dist/mcp-server/tools/definitions/fetch-frames.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/find-holders.tool.d.ts +67 -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 +61 -31
- 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 +119 -3
- 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 +101 -36
- 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 +108 -0
- package/dist/mcp-server/tools/definitions/get-filing.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-filing.tool.js +19 -9
- package/dist/mcp-server/tools/definitions/get-filing.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-financials.tool.js +1 -1
- 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 +91 -0
- 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 +25 -17
- 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 +79 -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 +34 -18
- 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 +153 -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 +403 -87
- 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 +70 -0
- 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 +27 -15
- package/dist/mcp-server/tools/definitions/get-material-events.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/index.d.ts +594 -544
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/index.js +24 -24
- package/dist/mcp-server/tools/definitions/index.js.map +1 -1
- package/dist/mcp-server/tools/definitions/search-filings.tool.d.ts +101 -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 +48 -29
- package/dist/mcp-server/tools/definitions/search-filings.tool.js.map +1 -1
- package/dist/mcp-server/tools/fixed-point.d.ts +7 -0
- package/dist/mcp-server/tools/fixed-point.d.ts.map +1 -0
- package/dist/mcp-server/tools/fixed-point.js +28 -0
- package/dist/mcp-server/tools/fixed-point.js.map +1 -0
- package/dist/mcp-server/tools/form-filter.d.ts +13 -0
- package/dist/mcp-server/tools/form-filter.d.ts.map +1 -0
- package/dist/mcp-server/tools/form-filter.js +16 -0
- package/dist/mcp-server/tools/form-filter.js.map +1 -0
- package/dist/mcp-server/tools/limit-clamp.d.ts +65 -0
- package/dist/mcp-server/tools/limit-clamp.d.ts.map +1 -0
- package/dist/mcp-server/tools/limit-clamp.js +78 -0
- package/dist/mcp-server/tools/limit-clamp.js.map +1 -0
- package/dist/services/edgar/concept-series.d.ts.map +1 -1
- package/dist/services/edgar/concept-series.js +5 -1
- package/dist/services/edgar/concept-series.js.map +1 -1
- package/dist/services/edgar/edgar-api-service.d.ts +18 -8
- package/dist/services/edgar/edgar-api-service.d.ts.map +1 -1
- package/dist/services/edgar/edgar-api-service.js +149 -32
- package/dist/services/edgar/edgar-api-service.js.map +1 -1
- package/dist/services/edgar/nport-parser.js +1 -1
- package/dist/services/edgar/nport-parser.js.map +1 -1
- package/dist/services/edgar/ownership-parser.d.ts +2 -0
- package/dist/services/edgar/ownership-parser.d.ts.map +1 -1
- package/dist/services/edgar/ownership-parser.js +4 -0
- package/dist/services/edgar/ownership-parser.js.map +1 -1
- package/dist/services/edgar/same-cik.d.ts +7 -0
- package/dist/services/edgar/same-cik.d.ts.map +1 -0
- package/dist/services/edgar/same-cik.js +9 -0
- package/dist/services/edgar/same-cik.js.map +1 -0
- package/dist/services/edgar/types.d.ts +3 -3
- package/package.json +7 -6
- package/server.json +3 -3
|
@@ -11,8 +11,13 @@
|
|
|
11
11
|
*
|
|
12
12
|
* @module mcp-server/tools/definitions/index
|
|
13
13
|
*/
|
|
14
|
-
|
|
15
|
-
|
|
14
|
+
import type { LimitClampOptions } from '../limit-clamp.js';
|
|
15
|
+
/**
|
|
16
|
+
* Deployment gates that decide how a tool enters the registration list.
|
|
17
|
+
* `clampOversizedLimits` (`EDGAR_CLAMP_OVERSIZED_LIMITS`) picks each clamped
|
|
18
|
+
* field's advertised maximum, so `tools/list` shows the bound in force (#197).
|
|
19
|
+
*/
|
|
20
|
+
export interface ToolDefinitionOptions extends LimitClampOptions {
|
|
16
21
|
/**
|
|
17
22
|
* `EDGAR_DATAFRAME_DROP_ENABLED`. When false, `secedgar_dataframe_drop` is
|
|
18
23
|
* registered through `disabledTool()` instead of live.
|
|
@@ -25,49 +30,384 @@ export interface ToolDefinitionOptions {
|
|
|
25
30
|
* it is present, so the manifest's tool count matches the documented surface.
|
|
26
31
|
*/
|
|
27
32
|
export declare function buildToolDefinitions(options: ToolDefinitionOptions): (import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
33
|
+
companies: import("zod").ZodArray<import("zod").ZodString>;
|
|
34
|
+
concepts: import("zod").ZodArray<import("zod").ZodString>;
|
|
35
|
+
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
36
|
+
"ifrs-full": "ifrs-full";
|
|
37
|
+
"us-gaap": "us-gaap";
|
|
38
|
+
}>>;
|
|
39
|
+
period_type: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
40
|
+
annual: "annual";
|
|
41
|
+
quarterly: "quarterly";
|
|
42
|
+
}>>;
|
|
43
|
+
periods: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
34
44
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
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
|
+
concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
64
|
+
concept: import("zod").ZodString;
|
|
65
|
+
label: import("zod").ZodString;
|
|
66
|
+
units: import("zod").ZodArray<import("zod").ZodString>;
|
|
67
|
+
}, import("zod/v4/core").$strip>>;
|
|
68
|
+
cells: import("zod").ZodArray<import("zod").ZodObject<{
|
|
69
|
+
cik: import("zod").ZodString;
|
|
70
|
+
company: import("zod").ZodString;
|
|
71
|
+
concept: import("zod").ZodString;
|
|
72
|
+
period: import("zod").ZodString;
|
|
73
|
+
value: import("zod").ZodNumber;
|
|
74
|
+
unit: import("zod").ZodString;
|
|
75
|
+
taxonomy: import("zod").ZodString;
|
|
76
|
+
tag: import("zod").ZodString;
|
|
77
|
+
frame: import("zod").ZodString;
|
|
78
|
+
period_end: import("zod").ZodString;
|
|
79
|
+
form: import("zod").ZodString;
|
|
80
|
+
accession_number: import("zod").ZodString;
|
|
81
|
+
}, import("zod/v4/core").$strip>>;
|
|
82
|
+
gaps: import("zod").ZodArray<import("zod").ZodObject<{
|
|
83
|
+
cik: import("zod").ZodString;
|
|
84
|
+
company: import("zod").ZodString;
|
|
85
|
+
concept: import("zod").ZodString;
|
|
86
|
+
tags_tried: import("zod").ZodArray<import("zod").ZodString>;
|
|
87
|
+
}, import("zod/v4/core").$strip>>;
|
|
88
|
+
unknown_concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
89
|
+
concept: import("zod").ZodString;
|
|
90
|
+
derivation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
91
|
+
suggestions: import("zod").ZodArray<import("zod").ZodString>;
|
|
92
|
+
}, import("zod/v4/core").$strip>>;
|
|
93
|
+
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
94
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
95
|
+
name: import("zod").ZodString;
|
|
96
|
+
row_count: import("zod").ZodNumber;
|
|
97
|
+
expires_at: import("zod").ZodString;
|
|
98
|
+
}, import("zod/v4/core").$strip>>;
|
|
99
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
100
|
+
readonly reason: "no_companies_resolved";
|
|
101
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
102
|
+
readonly when: "None of the supplied company inputs resolved to a CIK";
|
|
103
|
+
readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
|
|
104
|
+
}, {
|
|
105
|
+
readonly reason: "no_comparable_data";
|
|
106
|
+
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";
|
|
108
|
+
readonly recovery: "Switch period_type, or discover reported concept names with secedgar_search_concepts.";
|
|
109
|
+
}, {
|
|
110
|
+
readonly reason: "unknown_concept";
|
|
111
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
112
|
+
readonly when: "Every requested concept is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
|
|
113
|
+
readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
|
|
114
|
+
}, {
|
|
115
|
+
readonly reason: "rate_limited";
|
|
116
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
117
|
+
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";
|
|
118
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
119
|
+
readonly retryable: true;
|
|
120
|
+
readonly thrownBy: "service";
|
|
121
|
+
}, {
|
|
122
|
+
readonly reason: "sec_unreachable";
|
|
123
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
124
|
+
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";
|
|
125
|
+
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.";
|
|
126
|
+
readonly retryable: true;
|
|
127
|
+
readonly thrownBy: "service";
|
|
128
|
+
}], {
|
|
129
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
130
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
131
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
132
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
133
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
134
|
+
concept: import("zod").ZodString;
|
|
135
|
+
taxonomy: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
136
|
+
dei: "dei";
|
|
137
|
+
"us-gaap": "us-gaap";
|
|
138
|
+
}>>;
|
|
139
|
+
period: import("zod").ZodString;
|
|
140
|
+
unit: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
141
|
+
USD: "USD";
|
|
142
|
+
"USD-per-shares": "USD-per-shares";
|
|
143
|
+
"USD/shares": "USD/shares";
|
|
144
|
+
pure: "pure";
|
|
145
|
+
shares: "shares";
|
|
146
|
+
}>>;
|
|
147
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
148
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
149
|
+
sort: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
150
|
+
asc: "asc";
|
|
151
|
+
desc: "desc";
|
|
152
|
+
}>>;
|
|
153
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
154
|
+
concept: import("zod").ZodString;
|
|
155
|
+
taxonomy: import("zod").ZodString;
|
|
156
|
+
period: import("zod").ZodString;
|
|
157
|
+
unit: import("zod").ZodString;
|
|
158
|
+
label: import("zod").ZodString;
|
|
159
|
+
total_companies: import("zod").ZodNumber;
|
|
160
|
+
offset: import("zod").ZodNumber;
|
|
161
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
162
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
163
|
+
rank: import("zod").ZodNumber;
|
|
164
|
+
company_name: import("zod").ZodString;
|
|
165
|
+
cik: import("zod").ZodString;
|
|
166
|
+
ticker: import("zod").ZodOptional<import("zod").ZodString>;
|
|
167
|
+
value: import("zod").ZodNumber;
|
|
168
|
+
location: import("zod").ZodOptional<import("zod").ZodString>;
|
|
169
|
+
period_end: import("zod").ZodString;
|
|
170
|
+
accession_number: import("zod").ZodString;
|
|
171
|
+
}, import("zod/v4/core").$strip>>;
|
|
172
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
173
|
+
name: import("zod").ZodString;
|
|
174
|
+
row_count: import("zod").ZodNumber;
|
|
175
|
+
expires_at: import("zod").ZodString;
|
|
176
|
+
}, import("zod/v4/core").$strip>>;
|
|
177
|
+
unqueried_tags: import("zod").ZodArray<import("zod").ZodString>;
|
|
178
|
+
related_tags: import("zod").ZodArray<import("zod").ZodObject<{
|
|
179
|
+
tag: import("zod").ZodString;
|
|
180
|
+
note: import("zod").ZodString;
|
|
181
|
+
}, import("zod/v4/core").$strip>>;
|
|
182
|
+
value_distribution: import("zod").ZodObject<{
|
|
183
|
+
median: import("zod").ZodNumber;
|
|
184
|
+
p95: import("zod").ZodNumber;
|
|
185
|
+
max: import("zod").ZodNumber;
|
|
186
|
+
max_to_p95_ratio: import("zod").ZodNumber;
|
|
187
|
+
}, import("zod/v4/core").$strip>;
|
|
188
|
+
period_end_range: import("zod").ZodObject<{
|
|
189
|
+
min: import("zod").ZodString;
|
|
190
|
+
max: import("zod").ZodString;
|
|
191
|
+
}, import("zod/v4/core").$strip>;
|
|
192
|
+
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
193
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
194
|
+
readonly reason: "unknown_concept";
|
|
195
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
196
|
+
readonly when: "The concept input is neither a supported friendly name nor shaped like an XBRL tag, so no request is sent";
|
|
197
|
+
readonly recovery: "Use a friendly name from secedgar_search_concepts or a valid raw XBRL tag.";
|
|
198
|
+
}, {
|
|
199
|
+
readonly reason: "no_data";
|
|
200
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
201
|
+
readonly when: "Concept resolves but no companies report this metric for the requested period and unit";
|
|
202
|
+
readonly recovery: "Check duration vs instant period, unit, and that the period exists post-CY2009.";
|
|
203
|
+
}, {
|
|
204
|
+
readonly reason: "rate_limited";
|
|
205
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
206
|
+
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";
|
|
207
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
208
|
+
readonly retryable: true;
|
|
209
|
+
readonly thrownBy: "service";
|
|
210
|
+
}, {
|
|
211
|
+
readonly reason: "sec_unreachable";
|
|
212
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
213
|
+
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";
|
|
214
|
+
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.";
|
|
215
|
+
readonly retryable: true;
|
|
216
|
+
readonly thrownBy: "service";
|
|
217
|
+
}], {
|
|
218
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
219
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
220
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
221
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
222
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
223
|
+
issuer: import("zod").ZodString;
|
|
224
|
+
form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
225
|
+
"13D": "13D";
|
|
226
|
+
"13G": "13G";
|
|
227
|
+
all: "all";
|
|
228
|
+
}>>;
|
|
229
|
+
include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
230
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
231
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
232
|
+
issuer: import("zod").ZodString;
|
|
233
|
+
issuer_cik: import("zod").ZodString;
|
|
234
|
+
issuer_name: import("zod").ZodString;
|
|
235
|
+
form_kind: import("zod").ZodEnum<{
|
|
236
|
+
"13D": "13D";
|
|
237
|
+
"13G": "13G";
|
|
238
|
+
all: "all";
|
|
239
|
+
}>;
|
|
240
|
+
total_structured_filings: import("zod").ZodNumber;
|
|
241
|
+
filings_parsed: import("zod").ZodNumber;
|
|
242
|
+
filings_examined: import("zod").ZodNumber;
|
|
243
|
+
filings_excluded_other_issuer: import("zod").ZodNumber;
|
|
244
|
+
filings_not_examined: import("zod").ZodNumber;
|
|
245
|
+
filings_failed: import("zod").ZodArray<import("zod").ZodObject<{
|
|
46
246
|
accession_number: import("zod").ZodString;
|
|
247
|
+
reason: import("zod").ZodEnum<{
|
|
248
|
+
document_not_found: "document_not_found";
|
|
249
|
+
unparseable: "unparseable";
|
|
250
|
+
}>;
|
|
251
|
+
}, import("zod/v4/core").$strip>>;
|
|
252
|
+
partial: import("zod").ZodBoolean;
|
|
253
|
+
structured_coverage_from: import("zod").ZodString;
|
|
254
|
+
legacy_filings_before_coverage: import("zod").ZodNumber;
|
|
255
|
+
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
47
256
|
form: import("zod").ZodString;
|
|
257
|
+
schedule: import("zod").ZodEnum<{
|
|
258
|
+
"13D": "13D";
|
|
259
|
+
"13G": "13G";
|
|
260
|
+
}>;
|
|
261
|
+
is_amendment: import("zod").ZodBoolean;
|
|
262
|
+
amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
|
|
263
|
+
accession_number: import("zod").ZodString;
|
|
48
264
|
filing_date: import("zod").ZodString;
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
265
|
+
event_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
266
|
+
security_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
267
|
+
cusips: import("zod").ZodArray<import("zod").ZodString>;
|
|
268
|
+
purpose_of_transaction: import("zod").ZodOptional<import("zod").ZodString>;
|
|
269
|
+
purpose_truncated: import("zod").ZodBoolean;
|
|
270
|
+
reporting_persons: import("zod").ZodArray<import("zod").ZodObject<{
|
|
271
|
+
name: import("zod").ZodString;
|
|
272
|
+
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
273
|
+
citizenship: import("zod").ZodOptional<import("zod").ZodString>;
|
|
274
|
+
percent_of_class: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
275
|
+
aggregate_amount_owned: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
276
|
+
sole_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
277
|
+
shared_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
278
|
+
sole_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
279
|
+
shared_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
280
|
+
person_types: import("zod").ZodArray<import("zod").ZodString>;
|
|
281
|
+
excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
282
|
+
notes: import("zod").ZodOptional<import("zod").ZodString>;
|
|
283
|
+
}, import("zod/v4/core").$strip>>;
|
|
284
|
+
}, import("zod/v4/core").$strip>>;
|
|
285
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
286
|
+
name: import("zod").ZodString;
|
|
287
|
+
row_count: import("zod").ZodNumber;
|
|
288
|
+
expires_at: import("zod").ZodString;
|
|
289
|
+
truncated: import("zod").ZodBoolean;
|
|
290
|
+
}, import("zod/v4/core").$strip>>;
|
|
291
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
292
|
+
readonly reason: "issuer_not_found";
|
|
293
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
294
|
+
readonly when: "The issuer input does not resolve to a known EDGAR company";
|
|
295
|
+
readonly recovery: "Use secedgar_company_search to find the issuer ticker or 10-digit CIK.";
|
|
296
|
+
}, {
|
|
297
|
+
readonly reason: "ambiguous_issuer";
|
|
298
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
299
|
+
readonly when: "The issuer name matches several EDGAR companies";
|
|
300
|
+
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
301
|
+
}, {
|
|
302
|
+
readonly reason: "no_filings_found";
|
|
303
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
304
|
+
readonly when: "The issuer has no structured SCHEDULE 13D/13G filings matching the requested form kind";
|
|
305
|
+
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.";
|
|
306
|
+
}, {
|
|
307
|
+
readonly reason: "rate_limited";
|
|
308
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
309
|
+
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";
|
|
310
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
311
|
+
readonly retryable: true;
|
|
312
|
+
readonly thrownBy: "service";
|
|
313
|
+
}, {
|
|
314
|
+
readonly reason: "sec_unreachable";
|
|
315
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
316
|
+
readonly when: "SEC EDGAR gave no complete, readable response — on the last attempt made (the third, or an earlier one once this call's 40-second budget for SEC failures ran out) the connection failed, no response headers arrived within 15 seconds, or the body broke off or stalled for 15 seconds, each wait capped at what was left of that budget; a 200 body was not the JSON SEC serves; or earlier SEC failures had spent that budget, so the request was never sent";
|
|
317
|
+
readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
|
|
318
|
+
readonly retryable: true;
|
|
319
|
+
readonly thrownBy: "service";
|
|
320
|
+
}], {
|
|
321
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
322
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
323
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
324
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
325
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
326
|
+
accession_number: import("zod").ZodString;
|
|
327
|
+
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
328
|
+
content_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
329
|
+
document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
330
|
+
include_xbrl: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
331
|
+
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
332
|
+
section: import("zod").ZodOptional<import("zod").ZodString>;
|
|
333
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
334
|
+
accession_number: import("zod").ZodString;
|
|
335
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
336
|
+
filing_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
337
|
+
company_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
338
|
+
cik: import("zod").ZodString;
|
|
339
|
+
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
340
|
+
primary_document: import("zod").ZodString;
|
|
341
|
+
requested_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
342
|
+
documents: import("zod").ZodObject<{
|
|
343
|
+
primary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
344
|
+
name: import("zod").ZodString;
|
|
345
|
+
type: import("zod").ZodString;
|
|
346
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
347
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
348
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
349
|
+
}, import("zod/v4/core").$strip>>;
|
|
350
|
+
exhibits: import("zod").ZodArray<import("zod").ZodObject<{
|
|
351
|
+
name: import("zod").ZodString;
|
|
352
|
+
type: import("zod").ZodString;
|
|
353
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
354
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
355
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
356
|
+
}, import("zod/v4/core").$strip>>;
|
|
357
|
+
auxiliary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
358
|
+
name: import("zod").ZodString;
|
|
359
|
+
type: import("zod").ZodString;
|
|
360
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
361
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
362
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
363
|
+
}, import("zod/v4/core").$strip>>;
|
|
364
|
+
xbrl: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
365
|
+
name: import("zod").ZodString;
|
|
366
|
+
type: import("zod").ZodString;
|
|
367
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
368
|
+
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
369
|
+
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
370
|
+
}, import("zod/v4/core").$strip>>>;
|
|
371
|
+
}, import("zod/v4/core").$strip>;
|
|
372
|
+
content: import("zod").ZodString;
|
|
373
|
+
content_truncated: import("zod").ZodBoolean;
|
|
374
|
+
content_total_length: import("zod").ZodNumber;
|
|
375
|
+
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
376
|
+
outline: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
377
|
+
heading: import("zod").ZodString;
|
|
378
|
+
offset: import("zod").ZodNumber;
|
|
52
379
|
}, import("zod/v4/core").$strip>>>;
|
|
53
|
-
|
|
54
|
-
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
55
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
56
|
-
name: import("zod").ZodString;
|
|
57
|
-
row_count: import("zod").ZodNumber;
|
|
58
|
-
expires_at: import("zod").ZodString;
|
|
59
|
-
truncated: import("zod").ZodBoolean;
|
|
60
|
-
}, import("zod/v4/core").$strip>>;
|
|
380
|
+
filing_url: import("zod").ZodString;
|
|
61
381
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
62
|
-
readonly reason: "
|
|
382
|
+
readonly reason: "document_not_found";
|
|
63
383
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
64
|
-
readonly when: "
|
|
65
|
-
readonly recovery: "
|
|
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.";
|
|
66
386
|
}, {
|
|
67
|
-
readonly reason: "
|
|
387
|
+
readonly reason: "no_documents";
|
|
68
388
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
69
|
-
readonly when: "
|
|
70
|
-
readonly recovery: "
|
|
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.";
|
|
71
411
|
}, {
|
|
72
412
|
readonly reason: "rate_limited";
|
|
73
413
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -88,16 +428,6 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
88
428
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
89
429
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
90
430
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
91
|
-
name: import("zod").ZodString;
|
|
92
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
93
|
-
name: import("zod").ZodString;
|
|
94
|
-
dropped: import("zod").ZodBoolean;
|
|
95
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
96
|
-
readonly reason: "canvas_unavailable";
|
|
97
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
98
|
-
readonly when: "The DataCanvas service is not configured for this deployment";
|
|
99
|
-
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.";
|
|
100
|
-
}], undefined> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
101
431
|
fund: import("zod").ZodString;
|
|
102
432
|
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
103
433
|
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
@@ -252,6 +582,69 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
252
582
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
253
583
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
254
584
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
585
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
586
|
+
query: import("zod").ZodString;
|
|
587
|
+
include_filings: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
588
|
+
forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
589
|
+
filing_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
590
|
+
filed_after: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
591
|
+
filed_before: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
592
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
593
|
+
cik: import("zod").ZodString;
|
|
594
|
+
name: import("zod").ZodString;
|
|
595
|
+
tickers: import("zod").ZodArray<import("zod").ZodString>;
|
|
596
|
+
exchanges: import("zod").ZodArray<import("zod").ZodString>;
|
|
597
|
+
sic: import("zod").ZodString;
|
|
598
|
+
sic_description: import("zod").ZodString;
|
|
599
|
+
state_of_incorporation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
600
|
+
fiscal_year_end: import("zod").ZodOptional<import("zod").ZodString>;
|
|
601
|
+
series_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
602
|
+
class_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
603
|
+
filings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
604
|
+
accession_number: import("zod").ZodString;
|
|
605
|
+
form: import("zod").ZodString;
|
|
606
|
+
filing_date: import("zod").ZodString;
|
|
607
|
+
report_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
608
|
+
primary_document: import("zod").ZodString;
|
|
609
|
+
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
610
|
+
}, import("zod/v4/core").$strip>>>;
|
|
611
|
+
total_filings: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
612
|
+
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
613
|
+
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
614
|
+
name: import("zod").ZodString;
|
|
615
|
+
row_count: import("zod").ZodNumber;
|
|
616
|
+
expires_at: import("zod").ZodString;
|
|
617
|
+
truncated: import("zod").ZodBoolean;
|
|
618
|
+
}, import("zod/v4/core").$strip>>;
|
|
619
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
620
|
+
readonly reason: "no_match";
|
|
621
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
622
|
+
readonly when: "No company matches the query";
|
|
623
|
+
readonly recovery: "SEC's ticker index reflects the filer's own submissions record, which can differ from the exchange-listed symbol. ETFs and mutual funds resolve only by ticker (e.g. \"VOO\"); operating companies also resolve by full legal name or 10-digit CIK.";
|
|
624
|
+
}, {
|
|
625
|
+
readonly reason: "multiple_matches";
|
|
626
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
627
|
+
readonly when: "Query is ambiguous and matches several companies";
|
|
628
|
+
readonly recovery: "Specify a ticker symbol for an exact match instead of a name fragment.";
|
|
629
|
+
}, {
|
|
630
|
+
readonly reason: "rate_limited";
|
|
631
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
632
|
+
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";
|
|
633
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
634
|
+
readonly retryable: true;
|
|
635
|
+
readonly thrownBy: "service";
|
|
636
|
+
}, {
|
|
637
|
+
readonly reason: "sec_unreachable";
|
|
638
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
639
|
+
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";
|
|
640
|
+
readonly recovery: "Retry the same call in a minute — SEC EDGAR did not deliver a complete, readable response, and nothing in the request needs to change.";
|
|
641
|
+
readonly retryable: true;
|
|
642
|
+
readonly thrownBy: "service";
|
|
643
|
+
}], {
|
|
644
|
+
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
645
|
+
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
646
|
+
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
647
|
+
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
255
648
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
256
649
|
query: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
257
650
|
forms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
@@ -327,115 +720,9 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
327
720
|
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.";
|
|
328
721
|
}, {
|
|
329
722
|
readonly reason: "pre2001_full_text_unscoped";
|
|
330
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
331
|
-
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";
|
|
332
|
-
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.";
|
|
333
|
-
}, {
|
|
334
|
-
readonly reason: "rate_limited";
|
|
335
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
336
|
-
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";
|
|
337
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
338
|
-
readonly retryable: true;
|
|
339
|
-
readonly thrownBy: "service";
|
|
340
|
-
}, {
|
|
341
|
-
readonly reason: "sec_unreachable";
|
|
342
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
343
|
-
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";
|
|
344
|
-
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.";
|
|
345
|
-
readonly retryable: true;
|
|
346
|
-
readonly thrownBy: "service";
|
|
347
|
-
}], {
|
|
348
|
-
readonly effectiveQuery: import("zod").ZodString;
|
|
349
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
350
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
351
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
352
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
353
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
354
|
-
accession_number: import("zod").ZodString;
|
|
355
|
-
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
356
|
-
content_limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
357
|
-
document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
358
|
-
include_xbrl: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
359
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
360
|
-
section: import("zod").ZodOptional<import("zod").ZodString>;
|
|
361
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
362
|
-
accession_number: import("zod").ZodString;
|
|
363
|
-
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
364
|
-
filing_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
365
|
-
company_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
366
|
-
cik: import("zod").ZodString;
|
|
367
|
-
period_ending: import("zod").ZodOptional<import("zod").ZodString>;
|
|
368
|
-
primary_document: import("zod").ZodString;
|
|
369
|
-
requested_document: import("zod").ZodOptional<import("zod").ZodString>;
|
|
370
|
-
documents: import("zod").ZodObject<{
|
|
371
|
-
primary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
372
|
-
name: import("zod").ZodString;
|
|
373
|
-
type: import("zod").ZodString;
|
|
374
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
375
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
376
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
377
|
-
}, import("zod/v4/core").$strip>>;
|
|
378
|
-
exhibits: import("zod").ZodArray<import("zod").ZodObject<{
|
|
379
|
-
name: import("zod").ZodString;
|
|
380
|
-
type: import("zod").ZodString;
|
|
381
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
382
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
383
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
384
|
-
}, import("zod/v4/core").$strip>>;
|
|
385
|
-
auxiliary: import("zod").ZodArray<import("zod").ZodObject<{
|
|
386
|
-
name: import("zod").ZodString;
|
|
387
|
-
type: import("zod").ZodString;
|
|
388
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
389
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
390
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
391
|
-
}, import("zod/v4/core").$strip>>;
|
|
392
|
-
xbrl: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
393
|
-
name: import("zod").ZodString;
|
|
394
|
-
type: import("zod").ZodString;
|
|
395
|
-
description: import("zod").ZodOptional<import("zod").ZodString>;
|
|
396
|
-
size: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
397
|
-
binary: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
398
|
-
}, import("zod/v4/core").$strip>>>;
|
|
399
|
-
}, import("zod/v4/core").$strip>;
|
|
400
|
-
content: import("zod").ZodString;
|
|
401
|
-
content_truncated: import("zod").ZodBoolean;
|
|
402
|
-
content_total_length: import("zod").ZodNumber;
|
|
403
|
-
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
404
|
-
outline: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
405
|
-
heading: import("zod").ZodString;
|
|
406
|
-
offset: import("zod").ZodNumber;
|
|
407
|
-
}, import("zod/v4/core").$strip>>>;
|
|
408
|
-
filing_url: import("zod").ZodString;
|
|
409
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
410
|
-
readonly reason: "document_not_found";
|
|
411
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
412
|
-
readonly when: "A specific document was requested but not present in the filing archive";
|
|
413
|
-
readonly recovery: "Pick a filename from the categorized document list in the error message.";
|
|
414
|
-
}, {
|
|
415
|
-
readonly reason: "no_documents";
|
|
416
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
417
|
-
readonly when: "Filing index lists items but no fetchable primary document was found";
|
|
418
|
-
readonly recovery: "Set document to one of the filenames listed in the error message.";
|
|
419
|
-
}, {
|
|
420
|
-
readonly reason: "binary_document";
|
|
421
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
422
|
-
readonly when: "The requested document is a binary entry (scanned image, PDF, archive) with no text to return";
|
|
423
|
-
readonly recovery: "Pick a text document (.htm, .txt, .xml) from the list in the error message.";
|
|
424
|
-
}, {
|
|
425
|
-
readonly reason: "filing_not_found";
|
|
426
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
427
|
-
readonly when: "No filing matches the accession number under any candidate CIK";
|
|
428
|
-
readonly recovery: "Verify the accession number and pass the company CIK explicitly.";
|
|
429
|
-
}, {
|
|
430
|
-
readonly reason: "offset_out_of_range";
|
|
431
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
432
|
-
readonly when: "The provided offset is at or beyond the end of the document";
|
|
433
|
-
readonly recovery: "Use an offset less than the total document length shown in the error message.";
|
|
434
|
-
}, {
|
|
435
|
-
readonly reason: "section_not_found";
|
|
436
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
437
|
-
readonly when: "The section string matched no detected heading and no line of the document";
|
|
438
|
-
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.";
|
|
723
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
724
|
+
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";
|
|
725
|
+
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.";
|
|
439
726
|
}, {
|
|
440
727
|
readonly reason: "rate_limited";
|
|
441
728
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -451,6 +738,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
451
738
|
readonly retryable: true;
|
|
452
739
|
readonly thrownBy: "service";
|
|
453
740
|
}], {
|
|
741
|
+
readonly effectiveQuery: import("zod").ZodString;
|
|
454
742
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
455
743
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
456
744
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -655,259 +943,28 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
655
943
|
period_of_report: import("zod").ZodOptional<import("zod").ZodString>;
|
|
656
944
|
accession_number: import("zod").ZodString;
|
|
657
945
|
reporting_person: import("zod").ZodString;
|
|
658
|
-
relationship: import("zod").ZodString;
|
|
659
|
-
security_title: import("zod").ZodString;
|
|
660
|
-
transaction_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
661
|
-
transaction_code: import("zod").ZodString;
|
|
662
|
-
transaction_type: import("zod").ZodString;
|
|
663
|
-
is_derivative: import("zod").ZodBoolean;
|
|
664
|
-
shares_traded: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
665
|
-
direction: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
666
|
-
acquire: "acquire";
|
|
667
|
-
dispose: "dispose";
|
|
668
|
-
}>>;
|
|
669
|
-
price_per_share: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
670
|
-
shares_owned_after: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
671
|
-
ownership_type: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
672
|
-
direct: "direct";
|
|
673
|
-
indirect: "indirect";
|
|
674
|
-
}>>;
|
|
675
|
-
ownership_nature: import("zod").ZodOptional<import("zod").ZodString>;
|
|
676
|
-
}, import("zod/v4/core").$strip>>;
|
|
677
|
-
filings_scanned: import("zod").ZodNumber;
|
|
678
|
-
filings_other_issuer: import("zod").ZodNumber;
|
|
679
|
-
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
680
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
681
|
-
name: import("zod").ZodString;
|
|
682
|
-
row_count: import("zod").ZodNumber;
|
|
683
|
-
expires_at: import("zod").ZodString;
|
|
684
|
-
truncated: import("zod").ZodBoolean;
|
|
685
|
-
}, import("zod/v4/core").$strip>>;
|
|
686
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
687
|
-
readonly reason: "company_not_found";
|
|
688
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
689
|
-
readonly when: "The company input does not resolve to a known company";
|
|
690
|
-
readonly recovery: "Use secedgar_company_search to find the correct ticker or CIK.";
|
|
691
|
-
}, {
|
|
692
|
-
readonly reason: "no_filings_found";
|
|
693
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
694
|
-
readonly when: "A call without a date window finds no Form 4 filings in the recent submissions window";
|
|
695
|
-
readonly recovery: "Pass filed_after / filed_before to read an older period, or use secedgar_search_filings with forms=[\"4\"] to find the filings.";
|
|
696
|
-
}, {
|
|
697
|
-
readonly reason: "rate_limited";
|
|
698
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
699
|
-
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";
|
|
700
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
701
|
-
readonly retryable: true;
|
|
702
|
-
readonly thrownBy: "service";
|
|
703
|
-
}, {
|
|
704
|
-
readonly reason: "sec_unreachable";
|
|
705
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
706
|
-
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";
|
|
707
|
-
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.";
|
|
708
|
-
readonly retryable: true;
|
|
709
|
-
readonly thrownBy: "service";
|
|
710
|
-
}], {
|
|
711
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
712
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
713
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
714
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
715
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
716
|
-
company: import("zod").ZodString;
|
|
717
|
-
quarter: import("zod").ZodOptional<import("zod").ZodString>;
|
|
718
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
719
|
-
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
720
|
-
consolidate: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
721
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
722
|
-
filer_name: import("zod").ZodString;
|
|
723
|
-
filer_cik: import("zod").ZodString;
|
|
724
|
-
reporting_period: import("zod").ZodOptional<import("zod").ZodString>;
|
|
725
|
-
filing_date: import("zod").ZodString;
|
|
726
|
-
accession_number: import("zod").ZodString;
|
|
727
|
-
total_holdings_in_filing: import("zod").ZodNumber;
|
|
728
|
-
total_positions: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
729
|
-
offset: import("zod").ZodNumber;
|
|
730
|
-
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
731
|
-
holdings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
732
|
-
issuer_name: import("zod").ZodString;
|
|
733
|
-
title_of_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
734
|
-
cusip: import("zod").ZodOptional<import("zod").ZodString>;
|
|
735
|
-
market_value_usd: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
736
|
-
shares_or_principal_amount: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
737
|
-
shares_or_principal_type: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
738
|
-
PRN: "PRN";
|
|
739
|
-
SH: "SH";
|
|
740
|
-
}>>;
|
|
741
|
-
put_call: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
742
|
-
Call: "Call";
|
|
743
|
-
Put: "Put";
|
|
744
|
-
}>>;
|
|
745
|
-
investment_discretion: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
746
|
-
DFND: "DFND";
|
|
747
|
-
OTR: "OTR";
|
|
748
|
-
SOLE: "SOLE";
|
|
749
|
-
}>>;
|
|
750
|
-
}, import("zod/v4/core").$strip>>;
|
|
751
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
752
|
-
name: import("zod").ZodString;
|
|
753
|
-
row_count: import("zod").ZodNumber;
|
|
754
|
-
expires_at: import("zod").ZodString;
|
|
755
|
-
}, import("zod/v4/core").$strip>>;
|
|
756
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
757
|
-
readonly reason: "company_not_found";
|
|
758
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
759
|
-
readonly when: "The company input does not resolve to a known company or institution";
|
|
760
|
-
readonly recovery: "Use secedgar_company_search to find the correct CIK or full entity name.";
|
|
761
|
-
}, {
|
|
762
|
-
readonly reason: "ambiguous_entity";
|
|
763
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
764
|
-
readonly when: "The name resolves to multiple EDGAR entities (e.g. several filers sharing a legal name)";
|
|
765
|
-
readonly recovery: "Retry with the exact 10-digit CIK of the intended filer from the matches list.";
|
|
766
|
-
}, {
|
|
767
|
-
readonly reason: "no_filings_found";
|
|
768
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
769
|
-
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)";
|
|
770
|
-
readonly recovery: "Use secedgar_search_filings with forms=[\"13F-HR\"] for broader search, or check that the entity is an institutional investment manager.";
|
|
771
|
-
}, {
|
|
772
|
-
readonly reason: "no_info_table";
|
|
773
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
774
|
-
readonly when: "The 13F-HR filing was found but the information table XML document could not be located";
|
|
775
|
-
readonly recovery: "Use secedgar_get_filing with the accession number to inspect the filing documents directly.";
|
|
776
|
-
}, {
|
|
777
|
-
readonly reason: "rate_limited";
|
|
778
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
779
|
-
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";
|
|
780
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
781
|
-
readonly retryable: true;
|
|
782
|
-
readonly thrownBy: "service";
|
|
783
|
-
}, {
|
|
784
|
-
readonly reason: "sec_unreachable";
|
|
785
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
786
|
-
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";
|
|
787
|
-
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.";
|
|
788
|
-
readonly retryable: true;
|
|
789
|
-
readonly thrownBy: "service";
|
|
790
|
-
}], {
|
|
791
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
792
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
793
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
794
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
795
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
796
|
-
issuer: import("zod").ZodString;
|
|
797
|
-
cusip: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
798
|
-
quarter: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
799
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
800
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
801
|
-
issuer: import("zod").ZodString;
|
|
802
|
-
resolved_issuer_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
803
|
-
resolved_issuer_cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
804
|
-
search_mode: import("zod").ZodEnum<{
|
|
805
|
-
cusip: "cusip";
|
|
806
|
-
name: "name";
|
|
807
|
-
}>;
|
|
808
|
-
search_key: import("zod").ZodString;
|
|
809
|
-
quarter: import("zod").ZodString;
|
|
810
|
-
filed_from: import("zod").ZodString;
|
|
811
|
-
filed_to: import("zod").ZodString;
|
|
812
|
-
total_filings: import("zod").ZodNumber;
|
|
813
|
-
total_is_exact: import("zod").ZodBoolean;
|
|
814
|
-
fetched: import("zod").ZodNumber;
|
|
815
|
-
holders_in_quarter: import("zod").ZodNumber;
|
|
816
|
-
holders: import("zod").ZodArray<import("zod").ZodObject<{
|
|
817
|
-
filer_name: import("zod").ZodString;
|
|
818
|
-
filer_cik: import("zod").ZodString;
|
|
819
|
-
accession_number: import("zod").ZodString;
|
|
820
|
-
filing_date: import("zod").ZodString;
|
|
821
|
-
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
822
|
-
}, import("zod/v4/core").$strip>>;
|
|
823
|
-
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
824
|
-
name: import("zod").ZodString;
|
|
825
|
-
row_count: import("zod").ZodNumber;
|
|
826
|
-
expires_at: import("zod").ZodString;
|
|
827
|
-
truncated: import("zod").ZodBoolean;
|
|
828
|
-
}, import("zod/v4/core").$strip>>;
|
|
829
|
-
}, import("zod/v4/core").$strip>, readonly [{
|
|
830
|
-
readonly reason: "issuer_not_found";
|
|
831
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
832
|
-
readonly when: "No cusip was given and the issuer does not resolve to a known EDGAR company";
|
|
833
|
-
readonly recovery: "Confirm the issuer with secedgar_company_search, or pass the cusip parameter to search the information tables directly.";
|
|
834
|
-
}, {
|
|
835
|
-
readonly reason: "ambiguous_issuer";
|
|
836
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
837
|
-
readonly when: "The issuer name matches several EDGAR companies and no cusip was given";
|
|
838
|
-
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
839
|
-
}, {
|
|
840
|
-
readonly reason: "rate_limited";
|
|
841
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
842
|
-
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";
|
|
843
|
-
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
844
|
-
readonly retryable: true;
|
|
845
|
-
readonly thrownBy: "service";
|
|
846
|
-
}, {
|
|
847
|
-
readonly reason: "sec_unreachable";
|
|
848
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
849
|
-
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";
|
|
850
|
-
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.";
|
|
851
|
-
readonly retryable: true;
|
|
852
|
-
readonly thrownBy: "service";
|
|
853
|
-
}], {
|
|
854
|
-
readonly ordering: import("zod").ZodString;
|
|
855
|
-
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
856
|
-
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
857
|
-
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
858
|
-
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
859
|
-
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
860
|
-
issuer: import("zod").ZodString;
|
|
861
|
-
form_kind: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
862
|
-
"13D": "13D";
|
|
863
|
-
"13G": "13G";
|
|
864
|
-
all: "all";
|
|
865
|
-
}>>;
|
|
866
|
-
include_amendments: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
867
|
-
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
868
|
-
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
869
|
-
issuer: import("zod").ZodString;
|
|
870
|
-
issuer_cik: import("zod").ZodString;
|
|
871
|
-
issuer_name: import("zod").ZodString;
|
|
872
|
-
form_kind: import("zod").ZodEnum<{
|
|
873
|
-
"13D": "13D";
|
|
874
|
-
"13G": "13G";
|
|
875
|
-
all: "all";
|
|
876
|
-
}>;
|
|
877
|
-
total_structured_filings: import("zod").ZodNumber;
|
|
878
|
-
filings_parsed: import("zod").ZodNumber;
|
|
879
|
-
structured_coverage_from: import("zod").ZodString;
|
|
880
|
-
legacy_filings_before_coverage: import("zod").ZodNumber;
|
|
881
|
-
filings: import("zod").ZodArray<import("zod").ZodObject<{
|
|
882
|
-
form: import("zod").ZodString;
|
|
883
|
-
schedule: import("zod").ZodEnum<{
|
|
884
|
-
"13D": "13D";
|
|
885
|
-
"13G": "13G";
|
|
886
|
-
}>;
|
|
887
|
-
is_amendment: import("zod").ZodBoolean;
|
|
888
|
-
amendment_number: import("zod").ZodOptional<import("zod").ZodString>;
|
|
889
|
-
accession_number: import("zod").ZodString;
|
|
890
|
-
filing_date: import("zod").ZodString;
|
|
891
|
-
event_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
892
|
-
security_class: import("zod").ZodOptional<import("zod").ZodString>;
|
|
893
|
-
cusips: import("zod").ZodArray<import("zod").ZodString>;
|
|
894
|
-
purpose_of_transaction: import("zod").ZodOptional<import("zod").ZodString>;
|
|
895
|
-
purpose_truncated: import("zod").ZodBoolean;
|
|
896
|
-
reporting_persons: import("zod").ZodArray<import("zod").ZodObject<{
|
|
897
|
-
name: import("zod").ZodString;
|
|
898
|
-
cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
899
|
-
citizenship: import("zod").ZodOptional<import("zod").ZodString>;
|
|
900
|
-
percent_of_class: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
901
|
-
aggregate_amount_owned: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
902
|
-
sole_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
903
|
-
shared_voting_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
904
|
-
sole_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
905
|
-
shared_dispositive_power: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
906
|
-
person_types: import("zod").ZodArray<import("zod").ZodString>;
|
|
907
|
-
excludes_certain_shares: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
908
|
-
notes: import("zod").ZodOptional<import("zod").ZodString>;
|
|
909
|
-
}, import("zod/v4/core").$strip>>;
|
|
946
|
+
relationship: import("zod").ZodString;
|
|
947
|
+
security_title: import("zod").ZodString;
|
|
948
|
+
transaction_date: import("zod").ZodOptional<import("zod").ZodString>;
|
|
949
|
+
transaction_code: import("zod").ZodString;
|
|
950
|
+
transaction_type: import("zod").ZodString;
|
|
951
|
+
is_derivative: import("zod").ZodBoolean;
|
|
952
|
+
shares_traded: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
953
|
+
direction: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
954
|
+
acquire: "acquire";
|
|
955
|
+
dispose: "dispose";
|
|
956
|
+
}>>;
|
|
957
|
+
price_per_share: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
958
|
+
shares_owned_after: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
959
|
+
ownership_type: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
960
|
+
direct: "direct";
|
|
961
|
+
indirect: "indirect";
|
|
962
|
+
}>>;
|
|
963
|
+
ownership_nature: import("zod").ZodOptional<import("zod").ZodString>;
|
|
910
964
|
}, import("zod/v4/core").$strip>>;
|
|
965
|
+
filings_scanned: import("zod").ZodNumber;
|
|
966
|
+
filings_other_issuer: import("zod").ZodNumber;
|
|
967
|
+
history_scanned_through: import("zod").ZodOptional<import("zod").ZodString>;
|
|
911
968
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
912
969
|
name: import("zod").ZodString;
|
|
913
970
|
row_count: import("zod").ZodNumber;
|
|
@@ -915,20 +972,15 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
915
972
|
truncated: import("zod").ZodBoolean;
|
|
916
973
|
}, import("zod/v4/core").$strip>>;
|
|
917
974
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
918
|
-
readonly reason: "
|
|
975
|
+
readonly reason: "company_not_found";
|
|
919
976
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
920
|
-
readonly when: "The
|
|
921
|
-
readonly recovery: "Use secedgar_company_search to find the
|
|
922
|
-
}, {
|
|
923
|
-
readonly reason: "ambiguous_issuer";
|
|
924
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
925
|
-
readonly when: "The issuer name matches several EDGAR companies";
|
|
926
|
-
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
977
|
+
readonly when: "The company input does not resolve to a known company";
|
|
978
|
+
readonly recovery: "Use secedgar_company_search to find the correct ticker or CIK.";
|
|
927
979
|
}, {
|
|
928
980
|
readonly reason: "no_filings_found";
|
|
929
981
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
930
|
-
readonly when: "
|
|
931
|
-
readonly recovery: "
|
|
982
|
+
readonly when: "A call without a date window finds no Form 4 filings in the recent submissions window";
|
|
983
|
+
readonly recovery: "Pass filed_after / filed_before to read an older period, or use secedgar_search_filings with forms=[\"4\"] to find the filings.";
|
|
932
984
|
}, {
|
|
933
985
|
readonly reason: "rate_limited";
|
|
934
986
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -949,75 +1001,100 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
949
1001
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
950
1002
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
951
1003
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
dei: "dei";
|
|
955
|
-
"us-gaap": "us-gaap";
|
|
956
|
-
}>>;
|
|
957
|
-
period: import("zod").ZodString;
|
|
958
|
-
unit: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
959
|
-
USD: "USD";
|
|
960
|
-
"USD-per-shares": "USD-per-shares";
|
|
961
|
-
"USD/shares": "USD/shares";
|
|
962
|
-
pure: "pure";
|
|
963
|
-
shares: "shares";
|
|
964
|
-
}>>;
|
|
1004
|
+
company: import("zod").ZodString;
|
|
1005
|
+
quarter: import("zod").ZodOptional<import("zod").ZodString>;
|
|
965
1006
|
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
966
1007
|
offset: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
967
|
-
|
|
968
|
-
asc: "asc";
|
|
969
|
-
desc: "desc";
|
|
970
|
-
}>>;
|
|
1008
|
+
consolidate: import("zod").ZodDefault<import("zod").ZodBoolean>;
|
|
971
1009
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
1010
|
+
filer_name: import("zod").ZodString;
|
|
1011
|
+
filer_cik: import("zod").ZodString;
|
|
1012
|
+
reporting_period: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1013
|
+
filing_date: import("zod").ZodString;
|
|
1014
|
+
accession_number: import("zod").ZodString;
|
|
1015
|
+
amendments: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
1016
|
+
accession_number: import("zod").ZodString;
|
|
1017
|
+
filing_date: import("zod").ZodString;
|
|
1018
|
+
applied_as: import("zod").ZodEnum<{
|
|
1019
|
+
new_holdings: "new_holdings";
|
|
1020
|
+
not_applied: "not_applied";
|
|
1021
|
+
restatement: "restatement";
|
|
1022
|
+
superseded: "superseded";
|
|
1023
|
+
}>;
|
|
1024
|
+
amendment_type: import("zod").ZodEnum<{
|
|
1025
|
+
"NEW HOLDINGS": "NEW HOLDINGS";
|
|
1026
|
+
RESTATEMENT: "RESTATEMENT";
|
|
1027
|
+
}>;
|
|
1028
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1029
|
+
accession_number: import("zod").ZodString;
|
|
1030
|
+
filing_date: import("zod").ZodString;
|
|
1031
|
+
applied_as: import("zod").ZodEnum<{
|
|
1032
|
+
new_holdings: "new_holdings";
|
|
1033
|
+
not_applied: "not_applied";
|
|
1034
|
+
restatement: "restatement";
|
|
1035
|
+
superseded: "superseded";
|
|
1036
|
+
}>;
|
|
1037
|
+
amendment_type: import("zod").ZodLiteral<"UNAVAILABLE">;
|
|
1038
|
+
unavailable_reason: import("zod").ZodEnum<{
|
|
1039
|
+
lookup_failed: "lookup_failed";
|
|
1040
|
+
lookup_stopped: "lookup_stopped";
|
|
1041
|
+
missing_header: "missing_header";
|
|
1042
|
+
unreadable_header: "unreadable_header";
|
|
1043
|
+
}>;
|
|
1044
|
+
}, import("zod/v4/core").$strip>], "amendment_type">>>;
|
|
1045
|
+
amendment_search_complete: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1046
|
+
composed_accessions: import("zod").ZodArray<import("zod").ZodString>;
|
|
1047
|
+
total_holdings_in_filing: import("zod").ZodNumber;
|
|
1048
|
+
total_holdings_composed: import("zod").ZodNumber;
|
|
1049
|
+
total_positions: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
978
1050
|
offset: import("zod").ZodNumber;
|
|
979
1051
|
next_offset: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
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>;
|
|
989
1072
|
}, import("zod/v4/core").$strip>>;
|
|
990
1073
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
991
1074
|
name: import("zod").ZodString;
|
|
992
1075
|
row_count: import("zod").ZodNumber;
|
|
993
1076
|
expires_at: import("zod").ZodString;
|
|
994
1077
|
}, import("zod/v4/core").$strip>>;
|
|
995
|
-
unqueried_tags: import("zod").ZodArray<import("zod").ZodString>;
|
|
996
|
-
related_tags: import("zod").ZodArray<import("zod").ZodObject<{
|
|
997
|
-
tag: import("zod").ZodString;
|
|
998
|
-
note: import("zod").ZodString;
|
|
999
|
-
}, import("zod/v4/core").$strip>>;
|
|
1000
|
-
value_distribution: import("zod").ZodObject<{
|
|
1001
|
-
median: import("zod").ZodNumber;
|
|
1002
|
-
p95: import("zod").ZodNumber;
|
|
1003
|
-
max: import("zod").ZodNumber;
|
|
1004
|
-
max_to_p95_ratio: import("zod").ZodNumber;
|
|
1005
|
-
}, import("zod/v4/core").$strip>;
|
|
1006
|
-
period_end_range: import("zod").ZodObject<{
|
|
1007
|
-
min: import("zod").ZodString;
|
|
1008
|
-
max: import("zod").ZodString;
|
|
1009
|
-
}, import("zod/v4/core").$strip>;
|
|
1010
|
-
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
1011
1078
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1012
|
-
readonly reason: "
|
|
1079
|
+
readonly reason: "company_not_found";
|
|
1013
1080
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1014
|
-
readonly when: "The
|
|
1015
|
-
readonly recovery: "Use
|
|
1081
|
+
readonly when: "The company input does not resolve to a known company or institution";
|
|
1082
|
+
readonly recovery: "Use secedgar_company_search to find the correct CIK or full entity name.";
|
|
1016
1083
|
}, {
|
|
1017
|
-
readonly reason: "
|
|
1084
|
+
readonly reason: "ambiguous_entity";
|
|
1085
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1086
|
+
readonly when: "The name resolves to multiple EDGAR entities (e.g. several filers sharing a legal name)";
|
|
1087
|
+
readonly recovery: "Retry with the exact 10-digit CIK of the intended filer from the matches list.";
|
|
1088
|
+
}, {
|
|
1089
|
+
readonly reason: "no_filings_found";
|
|
1018
1090
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1019
|
-
readonly when: "
|
|
1020
|
-
readonly recovery: "
|
|
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.";
|
|
1021
1098
|
}, {
|
|
1022
1099
|
readonly reason: "rate_limited";
|
|
1023
1100
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1038,87 +1115,49 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1038
1115
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1039
1116
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1040
1117
|
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
"us-gaap": "us-gaap";
|
|
1046
|
-
}>>;
|
|
1047
|
-
period_type: import("zod").ZodDefault<import("zod").ZodEnum<{
|
|
1048
|
-
annual: "annual";
|
|
1049
|
-
quarterly: "quarterly";
|
|
1050
|
-
}>>;
|
|
1051
|
-
periods: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1118
|
+
issuer: import("zod").ZodString;
|
|
1119
|
+
cusip: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
1120
|
+
quarter: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<"">, import("zod").ZodString]>>;
|
|
1121
|
+
limit: import("zod").ZodDefault<import("zod").ZodNumber>;
|
|
1052
1122
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1072
|
-
concept: import("zod").ZodString;
|
|
1073
|
-
label: import("zod").ZodString;
|
|
1074
|
-
units: import("zod").ZodArray<import("zod").ZodString>;
|
|
1075
|
-
}, import("zod/v4/core").$strip>>;
|
|
1076
|
-
cells: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1077
|
-
cik: import("zod").ZodString;
|
|
1078
|
-
company: import("zod").ZodString;
|
|
1079
|
-
concept: import("zod").ZodString;
|
|
1080
|
-
period: import("zod").ZodString;
|
|
1081
|
-
value: import("zod").ZodNumber;
|
|
1082
|
-
unit: import("zod").ZodString;
|
|
1083
|
-
taxonomy: import("zod").ZodString;
|
|
1084
|
-
tag: import("zod").ZodString;
|
|
1085
|
-
frame: import("zod").ZodString;
|
|
1086
|
-
period_end: import("zod").ZodString;
|
|
1087
|
-
form: import("zod").ZodString;
|
|
1123
|
+
issuer: import("zod").ZodString;
|
|
1124
|
+
resolved_issuer_name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1125
|
+
resolved_issuer_cik: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1126
|
+
search_mode: import("zod").ZodEnum<{
|
|
1127
|
+
cusip: "cusip";
|
|
1128
|
+
name: "name";
|
|
1129
|
+
}>;
|
|
1130
|
+
search_key: import("zod").ZodString;
|
|
1131
|
+
quarter: import("zod").ZodString;
|
|
1132
|
+
filed_from: import("zod").ZodString;
|
|
1133
|
+
filed_to: import("zod").ZodString;
|
|
1134
|
+
total_filings: import("zod").ZodNumber;
|
|
1135
|
+
total_is_exact: import("zod").ZodBoolean;
|
|
1136
|
+
fetched: import("zod").ZodNumber;
|
|
1137
|
+
holders_in_quarter: import("zod").ZodNumber;
|
|
1138
|
+
holders: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1139
|
+
filer_name: import("zod").ZodString;
|
|
1140
|
+
filer_cik: import("zod").ZodString;
|
|
1088
1141
|
accession_number: import("zod").ZodString;
|
|
1142
|
+
filing_date: import("zod").ZodString;
|
|
1143
|
+
form: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1089
1144
|
}, import("zod/v4/core").$strip>>;
|
|
1090
|
-
gaps: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1091
|
-
cik: import("zod").ZodString;
|
|
1092
|
-
company: import("zod").ZodString;
|
|
1093
|
-
concept: import("zod").ZodString;
|
|
1094
|
-
tags_tried: import("zod").ZodArray<import("zod").ZodString>;
|
|
1095
|
-
}, import("zod/v4/core").$strip>>;
|
|
1096
|
-
unknown_concepts: import("zod").ZodArray<import("zod").ZodObject<{
|
|
1097
|
-
concept: import("zod").ZodString;
|
|
1098
|
-
derivation: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1099
|
-
suggestions: import("zod").ZodArray<import("zod").ZodString>;
|
|
1100
|
-
}, import("zod/v4/core").$strip>>;
|
|
1101
|
-
caveats: import("zod").ZodArray<import("zod").ZodString>;
|
|
1102
1145
|
dataset: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
1103
1146
|
name: import("zod").ZodString;
|
|
1104
1147
|
row_count: import("zod").ZodNumber;
|
|
1105
1148
|
expires_at: import("zod").ZodString;
|
|
1149
|
+
truncated: import("zod").ZodBoolean;
|
|
1106
1150
|
}, import("zod/v4/core").$strip>>;
|
|
1107
1151
|
}, import("zod/v4/core").$strip>, readonly [{
|
|
1108
|
-
readonly reason: "
|
|
1109
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1110
|
-
readonly when: "None of the supplied company inputs resolved to a CIK";
|
|
1111
|
-
readonly recovery: "Use ticker symbols or 10-digit CIK numbers for exact matches.";
|
|
1112
|
-
}, {
|
|
1113
|
-
readonly reason: "no_comparable_data";
|
|
1152
|
+
readonly reason: "issuer_not_found";
|
|
1114
1153
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.NotFound;
|
|
1115
|
-
readonly when: "
|
|
1116
|
-
readonly recovery: "
|
|
1154
|
+
readonly when: "No cusip was given and the issuer does not resolve to a known EDGAR company";
|
|
1155
|
+
readonly recovery: "Confirm the issuer with secedgar_company_search, or pass the cusip parameter to search the information tables directly.";
|
|
1117
1156
|
}, {
|
|
1118
|
-
readonly reason: "
|
|
1119
|
-
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.
|
|
1120
|
-
readonly when: "
|
|
1121
|
-
readonly recovery: "
|
|
1157
|
+
readonly reason: "ambiguous_issuer";
|
|
1158
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1159
|
+
readonly when: "The issuer name matches several EDGAR companies and no cusip was given";
|
|
1160
|
+
readonly recovery: "Retry with the ticker or the 10-digit CIK of the intended issuer from the matches list.";
|
|
1122
1161
|
}, {
|
|
1123
1162
|
readonly reason: "rate_limited";
|
|
1124
1163
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.RateLimited;
|
|
@@ -1134,6 +1173,7 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1134
1173
|
readonly retryable: true;
|
|
1135
1174
|
readonly thrownBy: "service";
|
|
1136
1175
|
}], {
|
|
1176
|
+
readonly ordering: import("zod").ZodString;
|
|
1137
1177
|
readonly notice: import("zod").ZodOptional<import("zod").ZodString>;
|
|
1138
1178
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1139
1179
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
@@ -1264,8 +1304,8 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1264
1304
|
}, {
|
|
1265
1305
|
readonly reason: "denied_function";
|
|
1266
1306
|
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ValidationError;
|
|
1267
|
-
readonly when: "The SQL calls a file-reading or external-data table function (read_csv, read_parquet, glob), a function that reads an engine setting (current_setting, current_schema), or one that runs SQL or names a table from a string (query_table, or query() over anything but a single string literal)";
|
|
1268
|
-
readonly recovery: "Remove the function the message names and query only the df_<id> tables secedgar_dataframe_describe lists.";
|
|
1307
|
+
readonly when: "The SQL calls a file-reading or external-data table function (read_csv, read_parquet, glob), a function that reads an engine setting (current_setting, current_schema — an unqualified current_schema is refused even where it names a column, which reads qualified as <table>.current_schema), or one that runs SQL or names a table from a string (query_table, or query() over anything but a single string literal)";
|
|
1308
|
+
readonly recovery: "Remove the function the message names, or qualify a column it names with its table, and query only the df_<id> tables secedgar_dataframe_describe lists.";
|
|
1269
1309
|
readonly thrownBy: "service";
|
|
1270
1310
|
}, {
|
|
1271
1311
|
readonly reason: "sql_read_only";
|
|
@@ -1284,5 +1324,15 @@ export declare function buildToolDefinitions(options: ToolDefinitionOptions): (i
|
|
|
1284
1324
|
readonly truncated: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1285
1325
|
readonly shown: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1286
1326
|
readonly cap: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
1287
|
-
}>)
|
|
1327
|
+
}> | import("@cyanheads/mcp-ts-core").ToolDefinition<import("zod").ZodObject<{
|
|
1328
|
+
name: import("zod").ZodString;
|
|
1329
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
1330
|
+
name: import("zod").ZodString;
|
|
1331
|
+
dropped: import("zod").ZodBoolean;
|
|
1332
|
+
}, import("zod/v4/core").$strip>, readonly [{
|
|
1333
|
+
readonly reason: "canvas_unavailable";
|
|
1334
|
+
readonly code: import("@cyanheads/mcp-ts-core/errors").JsonRpcErrorCode.ServiceUnavailable;
|
|
1335
|
+
readonly when: "The DataCanvas service is not configured for this deployment";
|
|
1336
|
+
readonly recovery: "Dataframes need the DuckDB canvas. On an npm or Docker install, set CANVAS_PROVIDER_TYPE=duckdb (the default when unset) and restart the server; the MCPB bundle ships without DuckDB, so there the data tools return their results inline and stage no dataframe.";
|
|
1337
|
+
}], undefined>)[];
|
|
1288
1338
|
//# sourceMappingURL=index.d.ts.map
|