@cyanheads/zenodo-mcp-server 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +435 -0
- package/CLAUDE.md +435 -0
- package/Dockerfile +140 -0
- package/LICENSE +201 -0
- package/README.md +292 -0
- package/changelog/0.1.x/0.1.1.md +21 -0
- package/changelog/template.md +151 -0
- package/dist/config/server-config.d.ts +13 -0
- package/dist/config/server-config.d.ts.map +1 -0
- package/dist/config/server-config.js +19 -0
- package/dist/config/server-config.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +21 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/get-record.tool.d.ts +186 -0
- package/dist/mcp-server/tools/definitions/get-record.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/get-record.tool.js +568 -0
- package/dist/mcp-server/tools/definitions/get-record.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/index.d.ts +721 -0
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/index.js +21 -0
- package/dist/mcp-server/tools/definitions/index.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-files.tool.d.ts +108 -0
- package/dist/mcp-server/tools/definitions/list-files.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-files.tool.js +348 -0
- package/dist/mcp-server/tools/definitions/list-files.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/list-versions.tool.d.ts +92 -0
- package/dist/mcp-server/tools/definitions/list-versions.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/list-versions.tool.js +268 -0
- package/dist/mcp-server/tools/definitions/list-versions.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/lookup-vocabulary.tool.d.ts +99 -0
- package/dist/mcp-server/tools/definitions/lookup-vocabulary.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/lookup-vocabulary.tool.js +324 -0
- package/dist/mcp-server/tools/definitions/lookup-vocabulary.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/read-file.tool.d.ts +104 -0
- package/dist/mcp-server/tools/definitions/read-file.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/read-file.tool.js +370 -0
- package/dist/mcp-server/tools/definitions/read-file.tool.js.map +1 -0
- package/dist/mcp-server/tools/definitions/search-records.tool.d.ts +181 -0
- package/dist/mcp-server/tools/definitions/search-records.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/search-records.tool.js +531 -0
- package/dist/mcp-server/tools/definitions/search-records.tool.js.map +1 -0
- package/dist/mcp-server/tools/record-miss.d.ts +37 -0
- package/dist/mcp-server/tools/record-miss.d.ts.map +1 -0
- package/dist/mcp-server/tools/record-miss.js +51 -0
- package/dist/mcp-server/tools/record-miss.js.map +1 -0
- package/dist/mcp-server/tools/render.d.ts +31 -0
- package/dist/mcp-server/tools/render.d.ts.map +1 -0
- package/dist/mcp-server/tools/render.js +53 -0
- package/dist/mcp-server/tools/render.js.map +1 -0
- package/dist/mcp-server/tools/schema-helpers.d.ts +20 -0
- package/dist/mcp-server/tools/schema-helpers.d.ts.map +1 -0
- package/dist/mcp-server/tools/schema-helpers.js +44 -0
- package/dist/mcp-server/tools/schema-helpers.js.map +1 -0
- package/dist/services/zenodo/cache.d.ts +25 -0
- package/dist/services/zenodo/cache.d.ts.map +1 -0
- package/dist/services/zenodo/cache.js +58 -0
- package/dist/services/zenodo/cache.js.map +1 -0
- package/dist/services/zenodo/html-to-text.d.ts +23 -0
- package/dist/services/zenodo/html-to-text.d.ts.map +1 -0
- package/dist/services/zenodo/html-to-text.js +148 -0
- package/dist/services/zenodo/html-to-text.js.map +1 -0
- package/dist/services/zenodo/http.d.ts +73 -0
- package/dist/services/zenodo/http.d.ts.map +1 -0
- package/dist/services/zenodo/http.js +378 -0
- package/dist/services/zenodo/http.js.map +1 -0
- package/dist/services/zenodo/identifiers.d.ts +104 -0
- package/dist/services/zenodo/identifiers.d.ts.map +1 -0
- package/dist/services/zenodo/identifiers.js +261 -0
- package/dist/services/zenodo/identifiers.js.map +1 -0
- package/dist/services/zenodo/normalize.d.ts +29 -0
- package/dist/services/zenodo/normalize.d.ts.map +1 -0
- package/dist/services/zenodo/normalize.js +324 -0
- package/dist/services/zenodo/normalize.js.map +1 -0
- package/dist/services/zenodo/query-builder.d.ts +87 -0
- package/dist/services/zenodo/query-builder.d.ts.map +1 -0
- package/dist/services/zenodo/query-builder.js +221 -0
- package/dist/services/zenodo/query-builder.js.map +1 -0
- package/dist/services/zenodo/resource-types.d.ts +34 -0
- package/dist/services/zenodo/resource-types.d.ts.map +1 -0
- package/dist/services/zenodo/resource-types.js +97 -0
- package/dist/services/zenodo/resource-types.js.map +1 -0
- package/dist/services/zenodo/text-preview.d.ts +56 -0
- package/dist/services/zenodo/text-preview.d.ts.map +1 -0
- package/dist/services/zenodo/text-preview.js +151 -0
- package/dist/services/zenodo/text-preview.js.map +1 -0
- package/dist/services/zenodo/types.d.ts +517 -0
- package/dist/services/zenodo/types.d.ts.map +1 -0
- package/dist/services/zenodo/types.js +8 -0
- package/dist/services/zenodo/types.js.map +1 -0
- package/dist/services/zenodo/zenodo-service.d.ts +98 -0
- package/dist/services/zenodo/zenodo-service.d.ts.map +1 -0
- package/dist/services/zenodo/zenodo-service.js +392 -0
- package/dist/services/zenodo/zenodo-service.js.map +1 -0
- package/package.json +110 -0
- package/server.json +113 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Casey Hand @cyanheads
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<h1>@cyanheads/zenodo-mcp-server</h1>
|
|
3
|
+
<p><b>Search and resolve Zenodo datasets, software, and publications by DOI; trace versions and funding, list files, and preview text files via MCP. STDIO or Streamable HTTP.</b>
|
|
4
|
+
<div>6 Tools</div>
|
|
5
|
+
</p>
|
|
6
|
+
</div>
|
|
7
|
+
|
|
8
|
+
<div align="center">
|
|
9
|
+
|
|
10
|
+
[](./CHANGELOG.md) [](./LICENSE) [](https://github.com/users/cyanheads/packages/container/package/zenodo-mcp-server) [](https://modelcontextprotocol.io/) [](https://www.npmjs.com/package/@cyanheads/zenodo-mcp-server) [](https://www.typescriptlang.org/) [](https://bun.sh/)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
<div align="center">
|
|
15
|
+
|
|
16
|
+
[](https://github.com/cyanheads/zenodo-mcp-server/releases/latest/download/zenodo-mcp-server.mcpb) [](https://cursor.com/en/install-mcp?name=zenodo-mcp-server&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjeWFuaGVhZHMvemVub2RvLW1jcC1zZXJ2ZXIiXX0=) [](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22zenodo-mcp-server%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40cyanheads%2Fzenodo-mcp-server%22%5D%7D)
|
|
17
|
+
|
|
18
|
+
[](https://www.npmjs.com/package/@cyanheads/mcp-ts-core)
|
|
19
|
+
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Overview
|
|
25
|
+
|
|
26
|
+
Datasets, software releases, and publications from Zenodo, CERN's open research repository, over its public REST API. Search deposits with filters for funder, grant, community, license, and file type; resolve any Zenodo DOI, concept DOI, or URL to its record; walk a deposit's versions; and list, open, and preview its files, including members of `.zip` archives. Runs as a stdio process or a local Streamable HTTP server.
|
|
27
|
+
|
|
28
|
+
### Tools
|
|
29
|
+
|
|
30
|
+
| Tool | Description |
|
|
31
|
+
|:---|:---|
|
|
32
|
+
| `zenodo_search_records` | Search deposits by keyword plus type, community, funder, grant, ORCID, file type, license, access, and date filters, with facet counts |
|
|
33
|
+
| `zenodo_get_record` | Resolve one deposit from a record id, DOI, concept DOI, or URL to its full metadata, first 25 files, and an optional citation |
|
|
34
|
+
| `zenodo_list_versions` | List every version of a deposit's version series, newest first |
|
|
35
|
+
| `zenodo_list_files` | Page a deposit's file manifest, or list the members of one of its `.zip` files |
|
|
36
|
+
| `zenodo_read_file` | Read a byte-capped text excerpt of one file or `.zip` member |
|
|
37
|
+
| `zenodo_lookup_vocabulary` | Resolve community, funder, grant, license, and resource-type names to the ids search filters take |
|
|
38
|
+
|
|
39
|
+
## Capability reference
|
|
40
|
+
|
|
41
|
+
### `zenodo_search_records` <sub>tool</sub>
|
|
42
|
+
|
|
43
|
+
- Keyword `query` (terms OR-ed unless joined with `AND`, quoted phrases, field syntax such as `metadata.title:"…"`) plus `resource_type`, `community`, `funder`, `award`, `creator_orcid`, `file_type`, `license`, `access_status`, and `published_from` / `published_to`
|
|
44
|
+
- Up to 25 hits per page; only the first 10,000 matches are reachable (`result_window_exceeded` past that); latest versions only unless `all_versions` is true
|
|
45
|
+
- `sort`: `bestmatch`, `newest`, `oldest`, `mostviewed`, `mostdownloaded`, `updated-desc`, `updated-asc` (default `bestmatch` with a query, `newest` without)
|
|
46
|
+
- Each hit carries record and concept ids and DOIs, type, version, creators, license ids, access, file totals, and unique views and downloads; `facets` count resource types, access statuses, file types, subjects, and years over the full match set
|
|
47
|
+
- A bare DOI or record URL as `query` fails as `query_is_identifier`; a `community` or `funder` Zenodo doesn't know fails as `unknown_community` / `unknown_funder`
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### `zenodo_get_record` <sub>tool</sub>
|
|
52
|
+
|
|
53
|
+
- `id` takes a record id, a Zenodo DOI, a concept DOI or concept record id (resolves to the latest version), another DOI registered to a Zenodo record, or a zenodo.org / doi.org URL; `input_kind` and `resolved_from` report how it resolved
|
|
54
|
+
- Returns the description as plain text (up to 4,000 characters), creators and contributors with ORCIDs and ROR affiliations, rights, access and embargo, funding, related identifiers, communities, version position with `latest_recid`, usage counts, and the first 25 files
|
|
55
|
+
- `citation_style`: `bibtex`, `csl-json`, `apa`, `chicago-author-date`, `harvard-cite-them-right`, `ieee`, `modern-language-association`, or `nature`
|
|
56
|
+
- A miss returns `found: false` with `miss_kind` (`not_found`, `deleted`, `restricted`, `not_on_zenodo`) and `guidance`; a deleted record adds its removal `tombstone`
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
### `zenodo_list_versions` <sub>tool</sub>
|
|
61
|
+
|
|
62
|
+
- Takes the same `id` forms as `zenodo_get_record`; a concept DOI and any version's DOI list the same series
|
|
63
|
+
- Newest first, up to 25 per page; reports `total_versions`, `latest_recid`, and the concept record id and DOI
|
|
64
|
+
- Each version carries its record id, DOI, version label, publication date, `index`, `is_latest`, file totals, and unique views and downloads
|
|
65
|
+
- Misses return `found: false` with the same `miss_kind`, `guidance`, and `tombstone` as `zenodo_get_record`
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
### `zenodo_list_files` <sub>tool</sub>
|
|
70
|
+
|
|
71
|
+
- Manifest entries carry key, size, MIME type, MD5, download URL, `previewable`, and `listable` (a `.zip`); up to 200 per page via `offset` / `limit`
|
|
72
|
+
- `archive_key` lists the members of one `.zip`; Zenodo lists at most 1,000 files and directories per archive, flagged by `upstream_truncated`
|
|
73
|
+
- `key_contains` filters keys or member paths case-insensitively before paging
|
|
74
|
+
- Restricted and embargoed files return the access status and embargo date with no entries; unknown and deleted records fail as `record_not_found` / `record_deleted`
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
### `zenodo_read_file` <sub>tool</sub>
|
|
79
|
+
|
|
80
|
+
- `key` from `zenodo_list_files`, plus `archive_member` to read inside a `.zip` without downloading it
|
|
81
|
+
- `max_bytes` 256–65,536 (default 16,384); continue a top-level file from `next_offset`; `.zip` members read from byte 0 only
|
|
82
|
+
- `status` is `text`, `not_text`, `restricted`, or `empty`; excerpts end on a line or character boundary
|
|
83
|
+
- Extensionless files typed `application/octet-stream` (LICENSE, Makefile) are returned only when their content is UTF-8 text
|
|
84
|
+
- Every result carries the deposit's `rights` and the `download_url`
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
### `zenodo_lookup_vocabulary` <sub>tool</sub>
|
|
89
|
+
|
|
90
|
+
- `vocabulary`: `communities`, `funders`, `awards`, `licenses`, or `resource_types`; `query` by name, acronym, or keyword, or omit it to browse
|
|
91
|
+
- Each entry's `filter_param` and `filter_value` name the `zenodo_search_records` filter and the id to pass it
|
|
92
|
+
- `funder` scopes awards to one funder, as a ROR id, ROR URL, or Crossref Funder DOI
|
|
93
|
+
- Up to 25 entries per page
|
|
94
|
+
|
|
95
|
+
## Features
|
|
96
|
+
|
|
97
|
+
Built on [`@cyanheads/mcp-ts-core`](https://github.com/cyanheads/mcp-ts-core): stdio and Streamable HTTP transports, pluggable auth (`none` / `jwt` / `oauth`), swappable storage (`in-memory`, `filesystem`, `Supabase`, `Cloudflare KV/R2/D1`), structured logging with optional OpenTelemetry tracing.
|
|
98
|
+
|
|
99
|
+
Zenodo-specific:
|
|
100
|
+
|
|
101
|
+
- Accepts a record id, Zenodo DOI, concept DOI, external DOI, or zenodo.org / doi.org URL in every tool that takes `id`; URLs are parsed locally and never fetched
|
|
102
|
+
- Search filters compose into Zenodo's query, so facet counts agree with `total`; community and funder values are checked before the search runs
|
|
103
|
+
- Separate request pacers for Zenodo's search and general rate-limit buckets, backed by its `X-RateLimit-*` headers, plus a process-local cache (records 5 min, searches 60 s, vocabularies 1 h)
|
|
104
|
+
- Byte-range file reads and `.zip` member reads, with binary detection before any text is returned
|
|
105
|
+
|
|
106
|
+
Agent-friendly output:
|
|
107
|
+
|
|
108
|
+
- Misses as data: `zenodo_get_record` and `zenodo_list_versions` return `found: false` with a typed `miss_kind`, next-step `guidance`, and a deleted record's tombstone
|
|
109
|
+
- Depositor-supplied text is labeled untrusted: descriptions render as quoted blocks, file content in a code fence, and HTML descriptions are converted to plain text
|
|
110
|
+
- Search responses echo the `effectiveQuery` sent to Zenodo and the `appliedSort`, and every paged tool reports totals with a next page or offset
|
|
111
|
+
- Fields Zenodo omits stay absent rather than defaulting to `0`, `''`, or `false`
|
|
112
|
+
|
|
113
|
+
## Getting started
|
|
114
|
+
|
|
115
|
+
Add the following to your MCP client configuration file.
|
|
116
|
+
|
|
117
|
+
```json
|
|
118
|
+
{
|
|
119
|
+
"mcpServers": {
|
|
120
|
+
"zenodo-mcp-server": {
|
|
121
|
+
"type": "stdio",
|
|
122
|
+
"command": "bunx",
|
|
123
|
+
"args": ["@cyanheads/zenodo-mcp-server@latest"],
|
|
124
|
+
"env": {
|
|
125
|
+
"MCP_TRANSPORT_TYPE": "stdio",
|
|
126
|
+
"MCP_LOG_LEVEL": "info"
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Or with npx (no Bun required):
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"mcpServers": {
|
|
138
|
+
"zenodo-mcp-server": {
|
|
139
|
+
"type": "stdio",
|
|
140
|
+
"command": "npx",
|
|
141
|
+
"args": ["-y", "@cyanheads/zenodo-mcp-server@latest"],
|
|
142
|
+
"env": {
|
|
143
|
+
"MCP_TRANSPORT_TYPE": "stdio",
|
|
144
|
+
"MCP_LOG_LEVEL": "info"
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Or with Docker:
|
|
152
|
+
|
|
153
|
+
```json
|
|
154
|
+
{
|
|
155
|
+
"mcpServers": {
|
|
156
|
+
"zenodo-mcp-server": {
|
|
157
|
+
"type": "stdio",
|
|
158
|
+
"command": "docker",
|
|
159
|
+
"args": ["run", "-i", "--rm", "-e", "MCP_TRANSPORT_TYPE=stdio", "ghcr.io/cyanheads/zenodo-mcp-server:latest"]
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
To raise the rate limit, add `"ZENODO_ACCESS_TOKEN": "your-token"` to `env` (or `-e ZENODO_ACCESS_TOKEN=…` for Docker). See [Configuration](#configuration).
|
|
166
|
+
|
|
167
|
+
For Streamable HTTP, set the transport and start the server:
|
|
168
|
+
|
|
169
|
+
```sh
|
|
170
|
+
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 bun run start:http
|
|
171
|
+
# Server listens at http://localhost:3010/mcp
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Prerequisites
|
|
175
|
+
|
|
176
|
+
- [Bun v1.4.0](https://bun.sh/) or higher (or Node.js v24+).
|
|
177
|
+
- Optional: a [Zenodo personal access token](https://zenodo.org/account/settings/applications/tokens/new/) for a higher rate limit.
|
|
178
|
+
|
|
179
|
+
### Installation
|
|
180
|
+
|
|
181
|
+
1. **Clone the repository:**
|
|
182
|
+
|
|
183
|
+
```sh
|
|
184
|
+
git clone https://github.com/cyanheads/zenodo-mcp-server.git
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
2. **Navigate into the directory:**
|
|
188
|
+
|
|
189
|
+
```sh
|
|
190
|
+
cd zenodo-mcp-server
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
3. **Install dependencies:**
|
|
194
|
+
|
|
195
|
+
```sh
|
|
196
|
+
bun install
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
4. **Configure environment:**
|
|
200
|
+
|
|
201
|
+
```sh
|
|
202
|
+
cp .env.example .env
|
|
203
|
+
# optionally set ZENODO_ACCESS_TOKEN
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
## Configuration
|
|
207
|
+
|
|
208
|
+
| Variable | Description | Default |
|
|
209
|
+
|:---|:---|:---|
|
|
210
|
+
| `ZENODO_ACCESS_TOKEN` | Zenodo personal access token, created with no scopes. Raises Zenodo's rate limit; tool behavior and page sizes are unchanged. | none |
|
|
211
|
+
| `MCP_TRANSPORT_TYPE` | Transport: `stdio` or `http`. | `stdio` |
|
|
212
|
+
| `MCP_HTTP_PORT` | HTTP server port. | `3010` |
|
|
213
|
+
| `MCP_SESSION_MODE` | HTTP session mode: `stateless`, `stateful`, or `auto`. | `stateless` |
|
|
214
|
+
| `MCP_AUTH_MODE` | Authentication: `none`, `jwt`, or `oauth`. | `none` |
|
|
215
|
+
| `MCP_LOG_LEVEL` | Log level (`debug`, `info`, `warning`, `error`, etc.). | `info` |
|
|
216
|
+
| `LOGS_DIR` | Directory for log files (Node.js only). | `<app-root>/logs` |
|
|
217
|
+
| `STORAGE_PROVIDER_TYPE` | Storage backend: `in-memory`, `filesystem`, `supabase`, `cloudflare-kv/r2/d1`. | `in-memory` |
|
|
218
|
+
| `OTEL_ENABLED` | Enable [OpenTelemetry](https://github.com/cyanheads/mcp-ts-core/tree/main/docs/telemetry). | `false` |
|
|
219
|
+
|
|
220
|
+
See [`.env.example`](./.env.example) for the full list of optional overrides.
|
|
221
|
+
|
|
222
|
+
### Rate limits
|
|
223
|
+
|
|
224
|
+
Zenodo rate-limits anonymous clients per IP address: 60 requests per minute and 2,000 per hour overall, and 30 per minute on record search. The server paces its own requests below those limits: 25 searches per minute, and 55 other requests per minute and 1,900 per hour. Every caller of one server process shares that budget. When it runs out, tools fail with `rate_limited` and a `retryAfter` in seconds.
|
|
225
|
+
|
|
226
|
+
With `ZENODO_ACCESS_TOKEN` set, Zenodo allows 100 requests per minute and 5,000 per hour, and the server paces other requests at 90 per minute and 4,800 per hour. Search stays at 25 per minute.
|
|
227
|
+
|
|
228
|
+
The token authenticates as the account that created it, so reads can see what that account can see, including restricted records it owns. On a shared or hosted server, create the token on a dedicated account that owns no restricted records.
|
|
229
|
+
|
|
230
|
+
## Running the server
|
|
231
|
+
|
|
232
|
+
### Local development
|
|
233
|
+
|
|
234
|
+
- **Build and run the production version**:
|
|
235
|
+
|
|
236
|
+
```sh
|
|
237
|
+
# One-time build
|
|
238
|
+
bun run rebuild
|
|
239
|
+
|
|
240
|
+
# Run the built server
|
|
241
|
+
bun run start:http
|
|
242
|
+
# or
|
|
243
|
+
bun run start:stdio
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
- **Run checks and tests**:
|
|
247
|
+
```sh
|
|
248
|
+
bun run devcheck # Lints, formats, type-checks, and more
|
|
249
|
+
bun run test # Runs the test suite
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Docker
|
|
253
|
+
|
|
254
|
+
```sh
|
|
255
|
+
docker build -t zenodo-mcp-server .
|
|
256
|
+
docker run --rm -p 3010:3010 zenodo-mcp-server
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
The Dockerfile defaults to HTTP transport, stateless session mode, and logs to `/var/log/zenodo-mcp-server`. OpenTelemetry peer dependencies are installed by default; build with `--build-arg OTEL_ENABLED=false` to omit them.
|
|
260
|
+
|
|
261
|
+
## Project structure
|
|
262
|
+
|
|
263
|
+
| Directory | Purpose |
|
|
264
|
+
|:---|:---|
|
|
265
|
+
| `src/index.ts` | `createApp()` entry point: server instructions, tool registration, service setup and teardown. |
|
|
266
|
+
| `src/config` | Server-specific environment variable parsing and validation with Zod. |
|
|
267
|
+
| `src/mcp-server/tools` | Tool definitions (`*.tool.ts`) plus shared render, schema, and record-miss helpers. |
|
|
268
|
+
| `src/services/zenodo` | Zenodo service: HTTP boundary and pacers, cache, identifier parsing, query building, normalization, text previews. |
|
|
269
|
+
| `tests/` | Unit, service, tool, and fuzz tests against recorded Zenodo fixtures. |
|
|
270
|
+
| `docs/design.md` | Tool surface design, verified upstream behavior, and decisions log. |
|
|
271
|
+
|
|
272
|
+
## Development guide
|
|
273
|
+
|
|
274
|
+
See [`CLAUDE.md`](./CLAUDE.md) for development guidelines and architectural rules. The short version:
|
|
275
|
+
|
|
276
|
+
- Handlers throw, framework catches — no `try/catch` in tool logic
|
|
277
|
+
- Use `ctx.log` for logging; Zenodo responses are cached process-wide in the service, not in `ctx.state`
|
|
278
|
+
- Register new tools in `src/mcp-server/tools/definitions/index.ts`
|
|
279
|
+
- Wrap external API calls: validate raw → normalize to domain type → return output schema; never fabricate missing fields
|
|
280
|
+
|
|
281
|
+
## Contributing
|
|
282
|
+
|
|
283
|
+
Issues are welcome. Run checks and tests before submitting:
|
|
284
|
+
|
|
285
|
+
```sh
|
|
286
|
+
bun run devcheck
|
|
287
|
+
bun run test
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
## License
|
|
291
|
+
|
|
292
|
+
This project is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "First public release: six read-only tools for searching Zenodo, resolving deposits by DOI or URL, walking version series, and listing and reading files, including .zip members."
|
|
3
|
+
breaking: false
|
|
4
|
+
security: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# 0.1.1 — 2026-09-24
|
|
8
|
+
|
|
9
|
+
First public release. Keyless; the optional `ZENODO_ACCESS_TOKEN` only raises the rate limit.
|
|
10
|
+
|
|
11
|
+
## Added
|
|
12
|
+
|
|
13
|
+
- **`zenodo_search_records`** — keyword search with type, community, funder, award, ORCID, file type, license, access, and date filters, up to 25 hits per page. Filters compose into `q`, so `facets` counts agree with `total` ([#2](https://github.com/cyanheads/zenodo-mcp-server/issues/2)).
|
|
14
|
+
- **`zenodo_get_record`** — one deposit from a record id, DOI, concept DOI, or zenodo.org / doi.org URL, with its first 25 files and an optional citation. A miss returns `found: false` with `miss_kind`, `guidance`, and any `tombstone`.
|
|
15
|
+
- **`zenodo_list_versions`** — a deposit's version series, newest first. A page past the 10,000-result window fails as `result_window_exceeded` before any upstream call ([#1](https://github.com/cyanheads/zenodo-mcp-server/issues/1)).
|
|
16
|
+
- **`zenodo_list_files`** — pages a file manifest, or the members of one `.zip` with its `archive.download_url`. A miss in a truncated archive listing points to a direct `zenodo_read_file` member read ([#5](https://github.com/cyanheads/zenodo-mcp-server/issues/5)).
|
|
17
|
+
- **`zenodo_read_file`** — a byte-capped text excerpt of a file or `.zip` member. Extensionless octet-stream files such as LICENSE are read when their content is UTF-8 ([#8](https://github.com/cyanheads/zenodo-mcp-server/issues/8)); a truncated member read names the `max_bytes` that returns all of it ([#4](https://github.com/cyanheads/zenodo-mcp-server/issues/4)).
|
|
18
|
+
- **`zenodo_lookup_vocabulary`** — resolves community, funder, award, license, and resource-type names to the ids the search filters take, with zero-hit notices worded per vocabulary ([#7](https://github.com/cyanheads/zenodo-mcp-server/issues/7)).
|
|
19
|
+
- **Input normalization** — enum inputs fold case and separators, `resource_type` accepts the `<type>::<id>` form, and wrapped ids with trailing punctuation resolve ([#3](https://github.com/cyanheads/zenodo-mcp-server/issues/3), [#6](https://github.com/cyanheads/zenodo-mcp-server/issues/6), [#9](https://github.com/cyanheads/zenodo-mcp-server/issues/9)).
|
|
20
|
+
- **Pacing and caching** — separate pacers for Zenodo's search and general rate-limit buckets, an `X-RateLimit-*` header gate, and a process-local response cache.
|
|
21
|
+
- **Upstream hardening** — `.`/`..` file and member paths are refused, redirects stay on zenodo.org, bodies are size-capped, HTML and id parsing run in linear time, and a query cannot drop or widen a filter clause.
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
---
|
|
2
|
+
# FORMAT REFERENCE — do not edit. Copy this file to
|
|
3
|
+
# `changelog/<major.minor>.x/<version>.md` (e.g. `changelog/0.8.x/0.8.6.md`)
|
|
4
|
+
# to author a new release. Set that file's H1 to `# <version> — YYYY-MM-DD`
|
|
5
|
+
# with a concrete date.
|
|
6
|
+
|
|
7
|
+
# Required. One-line GitHub Release-style headline. 350 character cap — a
|
|
8
|
+
# ceiling, not a target. Default short and scannable. Don't pad, don't stitch
|
|
9
|
+
# unrelated changes with commas/semicolons into an inventory — pick the one
|
|
10
|
+
# headline the release is about. Quotes required: unquoted YAML treats
|
|
11
|
+
# `: ` inside the value as a key separator and fails GitHub's strict parser.
|
|
12
|
+
summary: ""
|
|
13
|
+
|
|
14
|
+
# Set `true` when consumers must change code to upgrade: API removals,
|
|
15
|
+
# signature changes, config renames, behavior changes that break existing
|
|
16
|
+
# usage. Flagged as `Breaking` in the rollup.
|
|
17
|
+
breaking: false
|
|
18
|
+
|
|
19
|
+
# Set `true` ONLY for a security fix in THIS project's own source code — a
|
|
20
|
+
# vulnerability or hardening in code you ship. A dependency or transitive CVE
|
|
21
|
+
# bump is routine maintenance, NOT a security release: record it under
|
|
22
|
+
# `## Dependencies` (with the advisory ID) and leave this `false`. When true,
|
|
23
|
+
# pairs with the `## Security` section below and flags `Security` in the rollup.
|
|
24
|
+
security: false
|
|
25
|
+
|
|
26
|
+
# Optional free-form notes for maintenance agents processing this release.
|
|
27
|
+
# Not rendered in CHANGELOG — consumed by agents running `maintenance` on
|
|
28
|
+
# downstream servers. ADOPTION STEPS ONLY — new files to create, fields to
|
|
29
|
+
# populate, one-time migration steps. Never a second rendering of the body:
|
|
30
|
+
# if a body bullet already says it, name the bullet's symbol instead of
|
|
31
|
+
# re-explaining. Omit the field entirely when there's nothing to say.
|
|
32
|
+
# agent-notes: |
|
|
33
|
+
# <instructions for downstream maintenance agents>
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
# <version> — YYYY-MM-DD
|
|
37
|
+
|
|
38
|
+
<!--
|
|
39
|
+
AUTHORING GUIDE — applies to the new per-version file you create from this
|
|
40
|
+
template.
|
|
41
|
+
|
|
42
|
+
Audience: someone scanning release notes to decide what affects them. Lead
|
|
43
|
+
each bullet with the symbol or concept name in **bold** so they can skip
|
|
44
|
+
what's irrelevant and zoom in on what's not.
|
|
45
|
+
|
|
46
|
+
Tone: terse, fact-dense, not verbose. Bullet shape: **symbol** + what
|
|
47
|
+
changed + at most one consumer-facing caveat. One sentence by default, two
|
|
48
|
+
when the second carries weight — a bullet past ~40 words or three sentences
|
|
49
|
+
is wrong. The depth lives one hop away: the linked issue carries the why,
|
|
50
|
+
the commit diff carries the how. The changelog names what changed and what
|
|
51
|
+
a consumer does about it; a reader who wants mechanism opens the link.
|
|
52
|
+
|
|
53
|
+
Model length on THIS guide, never on the previous entry — entries modeled
|
|
54
|
+
on entries compound.
|
|
55
|
+
|
|
56
|
+
Cut (each has shipped as a wall of text; these are the cruft):
|
|
57
|
+
- History/justification narration — how the bug worked, why the old
|
|
58
|
+
behavior was wrong. One short clause at most; the issue carries the story.
|
|
59
|
+
- Design-rationale defense — "chosen over Y because…", "guarding the
|
|
60
|
+
getter is not enough…". That is the author arguing with a reviewer;
|
|
61
|
+
reviewers read the PR, not the changelog.
|
|
62
|
+
- Defensive unchanged-clauses — "X is unchanged", "byte-identical to
|
|
63
|
+
<prev>". Keep one only where its absence would cause a real misread,
|
|
64
|
+
as a short parenthetical.
|
|
65
|
+
- Edge-case inventories — marker lists, not-flagged lists, escape tables.
|
|
66
|
+
Tests and the issue carry those.
|
|
67
|
+
- Mechanism walkthroughs (JSDoc, CLAUDE.md/AGENTS.md, or the relevant
|
|
68
|
+
skill own those), ceremonial framings ("This release introduces…"),
|
|
69
|
+
backwards-compat paragraphs, file-by-file test enumerations. Prefer
|
|
70
|
+
code/symbol names over English re-explanations.
|
|
71
|
+
|
|
72
|
+
Verified ≠ included: the every-claim-verified-from-the-diff rule bounds
|
|
73
|
+
the TRUTH of what you write, never the AMOUNT.
|
|
74
|
+
|
|
75
|
+
Example — same fact, right size:
|
|
76
|
+
|
|
77
|
+
TOO LONG: **`fetchWithTimeout`'s `timeoutMs` bounds the whole exchange**
|
|
78
|
+
(#341). `fetch` resolves once headers arrive and the deadline was
|
|
79
|
+
cleared as the helper returned, so a peer that answered promptly and
|
|
80
|
+
then stalled the stream held the request open indefinitely. A 2xx
|
|
81
|
+
carrying a body now comes back as a passthrough wrapper that disarms
|
|
82
|
+
the deadline when the body closes, errors, or is cancelled; …
|
|
83
|
+
[+90 more words of mechanism and edge cases]
|
|
84
|
+
|
|
85
|
+
RIGHT: **`fetchWithTimeout`'s `timeoutMs` now bounds the whole
|
|
86
|
+
exchange, not just the headers** (#341). A stalled body aborts with
|
|
87
|
+
the same `Timeout` error; the returned `Response` is a wrapper, so
|
|
88
|
+
identity assertions (`toBe(response)`) no longer hold.
|
|
89
|
+
|
|
90
|
+
Narrative intro: skip by default. Add one short sentence only when the
|
|
91
|
+
release theme genuinely needs framing the bullets can't carry. When many
|
|
92
|
+
bullets share one upgrade consequence, state it ONCE — intro line or
|
|
93
|
+
agent-notes — never per bullet.
|
|
94
|
+
|
|
95
|
+
Sections: Keep a Changelog order — Added, Changed, Deprecated, Removed,
|
|
96
|
+
Fixed, Security. Include only sections with entries; delete the rest
|
|
97
|
+
(including the commented-out scaffolding below). Don't ship empty headers.
|
|
98
|
+
|
|
99
|
+
Include: every distinct fact a reader needs to adopt or audit the release —
|
|
100
|
+
new exports, signatures, lint rule IDs, env vars, breaking changes, version
|
|
101
|
+
bumps on shipped skills. Nothing more.
|
|
102
|
+
|
|
103
|
+
Links: link issues, PRs, docs, or skills where they help a reader jump to
|
|
104
|
+
context. Once per item per entry — don't re-link the same issue in summary,
|
|
105
|
+
narrative, and bullet. Skip links for inline symbol names; code spans speak
|
|
106
|
+
for themselves.
|
|
107
|
+
|
|
108
|
+
Issue/PR URLs: use full URLs. GitHub's bare `#NN` auto-link only resolves
|
|
109
|
+
inside its own UI, not in npm reads or local editors.
|
|
110
|
+
|
|
111
|
+
[#38](https://github.com/cyanheads/mcp-ts-core/issues/38) ← issue
|
|
112
|
+
[#42](https://github.com/cyanheads/mcp-ts-core/pull/42) ← PR
|
|
113
|
+
|
|
114
|
+
Verify numbers exist before linking (`gh issue view NN`, `gh pr view NN`).
|
|
115
|
+
Never speculate on a future number — `#42` for an upcoming PR silently
|
|
116
|
+
resolves to whatever real item already owns 42, and timeline previews pull
|
|
117
|
+
in that unrelated item's metadata.
|
|
118
|
+
|
|
119
|
+
TAG ANNOTATIONS — the annotated tag body renders as the GitHub Release body
|
|
120
|
+
via `gh release create --notes-from-tag`. It is a condensed digest of this
|
|
121
|
+
entry, never a copy, and its format is owned by the `release-and-publish`
|
|
122
|
+
skill (step 4, "Create the annotated tag"): a short subject line without the
|
|
123
|
+
version, flat headline bullets — no Keep-a-Changelog section headers, no
|
|
124
|
+
gates line — at most one deps line, issue backlinks, and the changelog link
|
|
125
|
+
last. In release-PR mode the `git-wrapup` skill authors those bullets as the
|
|
126
|
+
PR body's `## Changes` and the tag copies them.
|
|
127
|
+
-->
|
|
128
|
+
|
|
129
|
+
## Added
|
|
130
|
+
|
|
131
|
+
-
|
|
132
|
+
|
|
133
|
+
## Changed
|
|
134
|
+
|
|
135
|
+
-
|
|
136
|
+
|
|
137
|
+
<!-- ## Deprecated
|
|
138
|
+
|
|
139
|
+
- -->
|
|
140
|
+
|
|
141
|
+
<!-- ## Removed
|
|
142
|
+
|
|
143
|
+
- -->
|
|
144
|
+
|
|
145
|
+
## Fixed
|
|
146
|
+
|
|
147
|
+
-
|
|
148
|
+
|
|
149
|
+
<!-- ## Security
|
|
150
|
+
|
|
151
|
+
- -->
|