@cyanheads/secedgar-mcp-server 0.15.15 → 0.17.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 +33 -15
- package/CLAUDE.md +33 -15
- package/Dockerfile +13 -2
- package/README.md +56 -116
- package/changelog/0.16.x/0.16.0.md +34 -0
- package/changelog/0.17.x/0.17.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 +17 -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 +26 -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-describe.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-describe.tool.js +1 -1
- package/dist/mcp-server/tools/definitions/dataframe-describe.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 +41 -17
- 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 +106 -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 +25 -15
- 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 +25 -12
- 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 +21 -11
- 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 +36 -15
- 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 +134 -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 +284 -85
- 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 +32 -17
- package/dist/mcp-server/tools/definitions/get-material-events.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/index.d.ts +24 -4
- 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-concepts.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-concepts.tool.js +3 -1
- package/dist/mcp-server/tools/definitions/search-concepts.tool.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 +53 -32
- package/dist/mcp-server/tools/definitions/search-filings.tool.js.map +1 -1
- 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/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/types.d.ts +3 -3
- package/package.json +8 -6
- package/server.json +3 -3
- package/skills/secedgar-guide/SKILL.md +67 -0
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @fileoverview Fetch 13F-HR quarterly institutional holdings by parsing the SEC EDGAR
|
|
3
|
-
* information table XML
|
|
3
|
+
* information table XML, composed with the quarter's 13F-HR/A amendments (#198).
|
|
4
|
+
* Institution lookup only — `company` is the 13F filer.
|
|
4
5
|
* The reverse direction (which institutions hold an issuer) is secedgar_find_holders,
|
|
5
6
|
* which searches the information tables by CUSIP and returns filer CIKs to feed back
|
|
6
7
|
* into this tool (#81).
|
|
@@ -8,6 +9,7 @@
|
|
|
8
9
|
*/
|
|
9
10
|
import { z } from '@cyanheads/mcp-ts-core';
|
|
10
11
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
12
|
+
import { type LimitClampOptions } from '../limit-clamp.js';
|
|
11
13
|
export declare const getInstitutionalHoldingsTool: import("@cyanheads/mcp-ts-core").ToolDefinition<z.ZodObject<{
|
|
12
14
|
company: z.ZodString;
|
|
13
15
|
quarter: z.ZodOptional<z.ZodString>;
|
|
@@ -23,6 +25,12 @@ export declare const getInstitutionalHoldingsTool: import("@cyanheads/mcp-ts-cor
|
|
|
23
25
|
amendments: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
24
26
|
accession_number: z.ZodString;
|
|
25
27
|
filing_date: z.ZodString;
|
|
28
|
+
applied_as: z.ZodEnum<{
|
|
29
|
+
new_holdings: "new_holdings";
|
|
30
|
+
not_applied: "not_applied";
|
|
31
|
+
restatement: "restatement";
|
|
32
|
+
superseded: "superseded";
|
|
33
|
+
}>;
|
|
26
34
|
amendment_type: z.ZodEnum<{
|
|
27
35
|
"NEW HOLDINGS": "NEW HOLDINGS";
|
|
28
36
|
RESTATEMENT: "RESTATEMENT";
|
|
@@ -30,6 +38,128 @@ export declare const getInstitutionalHoldingsTool: import("@cyanheads/mcp-ts-cor
|
|
|
30
38
|
}, z.core.$strip>, z.ZodObject<{
|
|
31
39
|
accession_number: z.ZodString;
|
|
32
40
|
filing_date: z.ZodString;
|
|
41
|
+
applied_as: z.ZodEnum<{
|
|
42
|
+
new_holdings: "new_holdings";
|
|
43
|
+
not_applied: "not_applied";
|
|
44
|
+
restatement: "restatement";
|
|
45
|
+
superseded: "superseded";
|
|
46
|
+
}>;
|
|
47
|
+
amendment_type: z.ZodLiteral<"UNAVAILABLE">;
|
|
48
|
+
unavailable_reason: z.ZodEnum<{
|
|
49
|
+
lookup_failed: "lookup_failed";
|
|
50
|
+
lookup_stopped: "lookup_stopped";
|
|
51
|
+
missing_header: "missing_header";
|
|
52
|
+
unreadable_header: "unreadable_header";
|
|
53
|
+
}>;
|
|
54
|
+
}, z.core.$strip>], "amendment_type">>>;
|
|
55
|
+
amendment_search_complete: z.ZodOptional<z.ZodBoolean>;
|
|
56
|
+
composed_accessions: z.ZodArray<z.ZodString>;
|
|
57
|
+
total_holdings_in_filing: z.ZodNumber;
|
|
58
|
+
total_holdings_composed: z.ZodNumber;
|
|
59
|
+
total_positions: z.ZodOptional<z.ZodNumber>;
|
|
60
|
+
offset: z.ZodNumber;
|
|
61
|
+
next_offset: z.ZodOptional<z.ZodNumber>;
|
|
62
|
+
holdings: z.ZodArray<z.ZodObject<{
|
|
63
|
+
issuer_name: z.ZodString;
|
|
64
|
+
title_of_class: z.ZodOptional<z.ZodString>;
|
|
65
|
+
cusip: z.ZodOptional<z.ZodString>;
|
|
66
|
+
market_value_usd: z.ZodOptional<z.ZodNumber>;
|
|
67
|
+
shares_or_principal_amount: z.ZodOptional<z.ZodNumber>;
|
|
68
|
+
shares_or_principal_type: z.ZodOptional<z.ZodEnum<{
|
|
69
|
+
PRN: "PRN";
|
|
70
|
+
SH: "SH";
|
|
71
|
+
}>>;
|
|
72
|
+
put_call: z.ZodOptional<z.ZodEnum<{
|
|
73
|
+
Call: "Call";
|
|
74
|
+
Put: "Put";
|
|
75
|
+
}>>;
|
|
76
|
+
investment_discretion: z.ZodOptional<z.ZodEnum<{
|
|
77
|
+
DFND: "DFND";
|
|
78
|
+
OTR: "OTR";
|
|
79
|
+
SOLE: "SOLE";
|
|
80
|
+
}>>;
|
|
81
|
+
source_accession_numbers: z.ZodArray<z.ZodString>;
|
|
82
|
+
}, z.core.$strip>>;
|
|
83
|
+
dataset: z.ZodOptional<z.ZodObject<{
|
|
84
|
+
name: z.ZodString;
|
|
85
|
+
row_count: z.ZodNumber;
|
|
86
|
+
expires_at: z.ZodString;
|
|
87
|
+
}, z.core.$strip>>;
|
|
88
|
+
}, z.core.$strip>, readonly [{
|
|
89
|
+
readonly reason: "company_not_found";
|
|
90
|
+
readonly code: JsonRpcErrorCode.NotFound;
|
|
91
|
+
readonly when: "The company input does not resolve to a known company or institution";
|
|
92
|
+
readonly recovery: "Use secedgar_company_search to find the correct CIK or full entity name.";
|
|
93
|
+
}, {
|
|
94
|
+
readonly reason: "ambiguous_entity";
|
|
95
|
+
readonly code: JsonRpcErrorCode.ValidationError;
|
|
96
|
+
readonly when: "The name resolves to multiple EDGAR entities (e.g. several filers sharing a legal name)";
|
|
97
|
+
readonly recovery: "Retry with the exact 10-digit CIK of the intended filer from the matches list.";
|
|
98
|
+
}, {
|
|
99
|
+
readonly reason: "no_filings_found";
|
|
100
|
+
readonly code: JsonRpcErrorCode.NotFound;
|
|
101
|
+
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)";
|
|
102
|
+
readonly recovery: "Use secedgar_search_filings with forms=[\"13F-HR\"] for broader search, or check that the entity is an institutional investment manager.";
|
|
103
|
+
}, {
|
|
104
|
+
readonly reason: "no_info_table";
|
|
105
|
+
readonly code: JsonRpcErrorCode.NotFound;
|
|
106
|
+
readonly when: "The 13F-HR filing was found but the information table XML document could not be located";
|
|
107
|
+
readonly recovery: "Use secedgar_get_filing with the accession number to inspect the filing documents directly.";
|
|
108
|
+
}, {
|
|
109
|
+
readonly reason: "rate_limited";
|
|
110
|
+
readonly code: JsonRpcErrorCode.RateLimited;
|
|
111
|
+
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";
|
|
112
|
+
readonly recovery: "Wait the retryAfter seconds the error carries, then retry — SEC lifts the block only once requests stop for ten minutes.";
|
|
113
|
+
readonly retryable: true;
|
|
114
|
+
readonly thrownBy: "service";
|
|
115
|
+
}, {
|
|
116
|
+
readonly reason: "sec_unreachable";
|
|
117
|
+
readonly code: JsonRpcErrorCode.ServiceUnavailable;
|
|
118
|
+
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";
|
|
119
|
+
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.";
|
|
120
|
+
readonly retryable: true;
|
|
121
|
+
readonly thrownBy: "service";
|
|
122
|
+
}], {
|
|
123
|
+
readonly notice: z.ZodOptional<z.ZodString>;
|
|
124
|
+
readonly truncated: z.ZodOptional<z.ZodBoolean>;
|
|
125
|
+
readonly shown: z.ZodOptional<z.ZodNumber>;
|
|
126
|
+
readonly cap: z.ZodOptional<z.ZodNumber>;
|
|
127
|
+
}>;
|
|
128
|
+
/** `secedgar_get_institutional_holdings` as this deployment's `EDGAR_CLAMP_OVERSIZED_LIMITS` builds it. */
|
|
129
|
+
export declare function createGetInstitutionalHoldingsTool(options: LimitClampOptions): import("@cyanheads/mcp-ts-core").ToolDefinition<z.ZodObject<{
|
|
130
|
+
company: z.ZodString;
|
|
131
|
+
quarter: z.ZodOptional<z.ZodString>;
|
|
132
|
+
limit: z.ZodDefault<z.ZodNumber>;
|
|
133
|
+
offset: z.ZodDefault<z.ZodNumber>;
|
|
134
|
+
consolidate: z.ZodDefault<z.ZodBoolean>;
|
|
135
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
136
|
+
filer_name: z.ZodString;
|
|
137
|
+
filer_cik: z.ZodString;
|
|
138
|
+
reporting_period: z.ZodOptional<z.ZodString>;
|
|
139
|
+
filing_date: z.ZodString;
|
|
140
|
+
accession_number: z.ZodString;
|
|
141
|
+
amendments: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
142
|
+
accession_number: z.ZodString;
|
|
143
|
+
filing_date: z.ZodString;
|
|
144
|
+
applied_as: z.ZodEnum<{
|
|
145
|
+
new_holdings: "new_holdings";
|
|
146
|
+
not_applied: "not_applied";
|
|
147
|
+
restatement: "restatement";
|
|
148
|
+
superseded: "superseded";
|
|
149
|
+
}>;
|
|
150
|
+
amendment_type: z.ZodEnum<{
|
|
151
|
+
"NEW HOLDINGS": "NEW HOLDINGS";
|
|
152
|
+
RESTATEMENT: "RESTATEMENT";
|
|
153
|
+
}>;
|
|
154
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
155
|
+
accession_number: z.ZodString;
|
|
156
|
+
filing_date: z.ZodString;
|
|
157
|
+
applied_as: z.ZodEnum<{
|
|
158
|
+
new_holdings: "new_holdings";
|
|
159
|
+
not_applied: "not_applied";
|
|
160
|
+
restatement: "restatement";
|
|
161
|
+
superseded: "superseded";
|
|
162
|
+
}>;
|
|
33
163
|
amendment_type: z.ZodLiteral<"UNAVAILABLE">;
|
|
34
164
|
unavailable_reason: z.ZodEnum<{
|
|
35
165
|
lookup_failed: "lookup_failed";
|
|
@@ -39,7 +169,9 @@ export declare const getInstitutionalHoldingsTool: import("@cyanheads/mcp-ts-cor
|
|
|
39
169
|
}>;
|
|
40
170
|
}, z.core.$strip>], "amendment_type">>>;
|
|
41
171
|
amendment_search_complete: z.ZodOptional<z.ZodBoolean>;
|
|
172
|
+
composed_accessions: z.ZodArray<z.ZodString>;
|
|
42
173
|
total_holdings_in_filing: z.ZodNumber;
|
|
174
|
+
total_holdings_composed: z.ZodNumber;
|
|
43
175
|
total_positions: z.ZodOptional<z.ZodNumber>;
|
|
44
176
|
offset: z.ZodNumber;
|
|
45
177
|
next_offset: z.ZodOptional<z.ZodNumber>;
|
|
@@ -62,6 +194,7 @@ export declare const getInstitutionalHoldingsTool: import("@cyanheads/mcp-ts-cor
|
|
|
62
194
|
OTR: "OTR";
|
|
63
195
|
SOLE: "SOLE";
|
|
64
196
|
}>>;
|
|
197
|
+
source_accession_numbers: z.ZodArray<z.ZodString>;
|
|
65
198
|
}, z.core.$strip>>;
|
|
66
199
|
dataset: z.ZodOptional<z.ZodObject<{
|
|
67
200
|
name: z.ZodString;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-institutional-holdings.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-institutional-holdings.tool.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"get-institutional-holdings.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-institutional-holdings.tool.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAQ,CAAC,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAA6B,MAAM,+BAA+B,CAAC;AAC5F,OAAO,EACL,KAAK,iBAAiB,EAGvB,MAAM,mCAAmC,CAAC;AAiY3C,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAotBvC,CAAC;AAEH,2GAA2G;AAC3G,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAE5E"}
|