@cyanheads/interpro-mcp-server 0.0.0-stage → 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.
Files changed (77) hide show
  1. package/AGENTS.md +375 -0
  2. package/CLAUDE.md +375 -0
  3. package/Dockerfile +186 -0
  4. package/LICENSE +201 -0
  5. package/README.md +263 -2
  6. package/changelog/0.1.x/0.1.1.md +20 -0
  7. package/changelog/template.md +151 -0
  8. package/dist/index.d.ts +7 -0
  9. package/dist/index.d.ts.map +1 -0
  10. package/dist/index.js +34 -0
  11. package/dist/index.js.map +1 -0
  12. package/dist/mcp-server/tools/definitions/interpro-find-proteins-by-domain.tool.d.ts +177 -0
  13. package/dist/mcp-server/tools/definitions/interpro-find-proteins-by-domain.tool.d.ts.map +1 -0
  14. package/dist/mcp-server/tools/definitions/interpro-find-proteins-by-domain.tool.js +192 -0
  15. package/dist/mcp-server/tools/definitions/interpro-find-proteins-by-domain.tool.js.map +1 -0
  16. package/dist/mcp-server/tools/definitions/interpro-get-clan.tool.d.ts +160 -0
  17. package/dist/mcp-server/tools/definitions/interpro-get-clan.tool.d.ts.map +1 -0
  18. package/dist/mcp-server/tools/definitions/interpro-get-clan.tool.js +259 -0
  19. package/dist/mcp-server/tools/definitions/interpro-get-clan.tool.js.map +1 -0
  20. package/dist/mcp-server/tools/definitions/interpro-get-entry.tool.d.ts +130 -0
  21. package/dist/mcp-server/tools/definitions/interpro-get-entry.tool.d.ts.map +1 -0
  22. package/dist/mcp-server/tools/definitions/interpro-get-entry.tool.js +100 -0
  23. package/dist/mcp-server/tools/definitions/interpro-get-entry.tool.js.map +1 -0
  24. package/dist/mcp-server/tools/definitions/interpro-get-protein-domains.tool.d.ts +172 -0
  25. package/dist/mcp-server/tools/definitions/interpro-get-protein-domains.tool.d.ts.map +1 -0
  26. package/dist/mcp-server/tools/definitions/interpro-get-protein-domains.tool.js +374 -0
  27. package/dist/mcp-server/tools/definitions/interpro-get-protein-domains.tool.js.map +1 -0
  28. package/dist/mcp-server/tools/definitions/interpro-list-reference.tool.d.ts +89 -0
  29. package/dist/mcp-server/tools/definitions/interpro-list-reference.tool.d.ts.map +1 -0
  30. package/dist/mcp-server/tools/definitions/interpro-list-reference.tool.js +99 -0
  31. package/dist/mcp-server/tools/definitions/interpro-list-reference.tool.js.map +1 -0
  32. package/dist/mcp-server/tools/definitions/interpro-search-entries.tool.d.ts +184 -0
  33. package/dist/mcp-server/tools/definitions/interpro-search-entries.tool.d.ts.map +1 -0
  34. package/dist/mcp-server/tools/definitions/interpro-search-entries.tool.js +155 -0
  35. package/dist/mcp-server/tools/definitions/interpro-search-entries.tool.js.map +1 -0
  36. package/dist/services/interpro/budget.d.ts +26 -0
  37. package/dist/services/interpro/budget.d.ts.map +1 -0
  38. package/dist/services/interpro/budget.js +41 -0
  39. package/dist/services/interpro/budget.js.map +1 -0
  40. package/dist/services/interpro/cursors.d.ts +25 -0
  41. package/dist/services/interpro/cursors.d.ts.map +1 -0
  42. package/dist/services/interpro/cursors.js +99 -0
  43. package/dist/services/interpro/cursors.js.map +1 -0
  44. package/dist/services/interpro/format.d.ts +17 -0
  45. package/dist/services/interpro/format.d.ts.map +1 -0
  46. package/dist/services/interpro/format.js +130 -0
  47. package/dist/services/interpro/format.js.map +1 -0
  48. package/dist/services/interpro/http-adapter.d.ts +11 -0
  49. package/dist/services/interpro/http-adapter.d.ts.map +1 -0
  50. package/dist/services/interpro/http-adapter.js +134 -0
  51. package/dist/services/interpro/http-adapter.js.map +1 -0
  52. package/dist/services/interpro/interpro-service.d.ts +57 -0
  53. package/dist/services/interpro/interpro-service.d.ts.map +1 -0
  54. package/dist/services/interpro/interpro-service.js +284 -0
  55. package/dist/services/interpro/interpro-service.js.map +1 -0
  56. package/dist/services/interpro/reference.d.ts +31 -0
  57. package/dist/services/interpro/reference.d.ts.map +1 -0
  58. package/dist/services/interpro/reference.js +122 -0
  59. package/dist/services/interpro/reference.js.map +1 -0
  60. package/dist/services/interpro/relationships.d.ts +38 -0
  61. package/dist/services/interpro/relationships.d.ts.map +1 -0
  62. package/dist/services/interpro/relationships.js +70 -0
  63. package/dist/services/interpro/relationships.js.map +1 -0
  64. package/dist/services/interpro/routing.d.ts +24 -0
  65. package/dist/services/interpro/routing.d.ts.map +1 -0
  66. package/dist/services/interpro/routing.js +106 -0
  67. package/dist/services/interpro/routing.js.map +1 -0
  68. package/dist/services/interpro/schemas.d.ts +182 -0
  69. package/dist/services/interpro/schemas.d.ts.map +1 -0
  70. package/dist/services/interpro/schemas.js +215 -0
  71. package/dist/services/interpro/schemas.js.map +1 -0
  72. package/dist/services/interpro/upstream-errors.d.ts +43 -0
  73. package/dist/services/interpro/upstream-errors.d.ts.map +1 -0
  74. package/dist/services/interpro/upstream-errors.js +49 -0
  75. package/dist/services/interpro/upstream-errors.js.map +1 -0
  76. package/package.json +103 -4
  77. package/server.json +85 -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 CHANGED
@@ -1,3 +1,264 @@
1
- # Temporary Holding Version
1
+ <div align="center">
2
+ <h1>@cyanheads/interpro-mcp-server</h1>
3
+ <p><b>Search InterPro entries, map protein domains and functional sites, and find proteins by domain via MCP. STDIO or Streamable HTTP.</b>
4
+ <div>6 Tools</div>
5
+ </p>
6
+ </div>
2
7
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
8
+ <div align="center">
9
+
10
+ [![Version](https://img.shields.io/badge/Version-0.1.1-blue.svg?style=flat-square)](./CHANGELOG.md) [![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg?style=flat-square)](./LICENSE) [![Docker](https://img.shields.io/badge/Docker-ghcr.io-2496ED?style=flat-square&logo=docker&logoColor=white)](https://github.com/users/cyanheads/packages/container/package/interpro-mcp-server) [![MCP SDK](https://img.shields.io/badge/MCP%20SDK-^2.3.1-green.svg?style=flat-square)](https://modelcontextprotocol.io/) [![npm](https://img.shields.io/npm/v/@cyanheads/interpro-mcp-server?style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/package/@cyanheads/interpro-mcp-server) [![TypeScript](https://img.shields.io/badge/TypeScript-^7.0.2-3178C6.svg?style=flat-square)](https://www.typescriptlang.org/) [![Bun](https://img.shields.io/badge/Bun-v1.4.3-blueviolet.svg?style=flat-square)](https://bun.sh/)
11
+
12
+ </div>
13
+
14
+ <div align="center">
15
+
16
+ [![Install in Claude Desktop](https://img.shields.io/badge/Install_in-Claude_Desktop-D97757?style=for-the-badge&logo=anthropic&logoColor=white)](https://github.com/cyanheads/interpro-mcp-server/releases/latest/download/interpro-mcp-server.mcpb) [![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=interpro-mcp-server&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjeWFuaGVhZHMvaW50ZXJwcm8tbWNwLXNlcnZlciJdfQ==) [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22interpro-mcp-server%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40cyanheads%2Finterpro-mcp-server%22%5D%7D)
17
+
18
+ [![Framework](https://img.shields.io/badge/Built%20on-@cyanheads/mcp--ts--core-67E8F9?style=flat-square)](https://www.npmjs.com/package/@cyanheads/mcp-ts-core)
19
+
20
+ </div>
21
+
22
+ ---
23
+
24
+ ## Overview
25
+
26
+ Protein families, domains, repeats, and functional sites from [InterPro](https://www.ebi.ac.uk/interpro/) and the member databases it integrates (Pfam, PROSITE, SMART, CDD, PANTHER, and others), read through the keyless EMBL-EBI InterPro API. Search entries, read their full metadata, map a UniProt protein's annotations to residue coordinates, walk Pfam, CDD, and PIRSF clans, and find proteins that carry a signature. Runs over STDIO or Streamable HTTP, with no credentials to configure.
27
+
28
+ ### Tools
29
+
30
+ | Tool | Description |
31
+ |:---|:---|
32
+ | `interpro_search_entries` | Find InterPro entries or member signatures by text, entry type, GO annotation, or integrating InterPro accession |
33
+ | `interpro_get_entry` | Read one entry's description, hierarchy, member signatures, GO terms, literature, cross-references, clan membership, and coverage counters |
34
+ | `interpro_get_protein_domains` | Map a UniProt protein's domains, families, repeats, and functional sites to sequence coordinates, optionally at one residue |
35
+ | `interpro_get_clan` | Read a Pfam, CDD, or PIRSF set and page through its members, optionally with its relationship graph |
36
+ | `interpro_find_proteins_by_domain` | Find UniProt proteins carrying an entry, defaulting to reviewed human proteins |
37
+ | `interpro_list_reference` | Decode database slugs, entry types, accession patterns, common taxon IDs, and the current InterPro release |
38
+
39
+ ## Capability reference
40
+
41
+ ### `interpro_search_entries` <sub>tool</sub>
42
+
43
+ - `sourceDatabase` (default `interpro`) plus optional `query` (1-300 characters), `entryType`, `goTerm` (`GO:0003677` form), `goCategory` (`P`, `F`, `C`), and `integratedInto` (an `IPR` accession, member databases only); no filter is required, so omitting all of them browses the database
44
+ - Cursor-paged, `limit` 1-100 (default 20); returns `entries`, `page` (`total`, `returned`, `hasMore`, `nextCursor`), and the applied `query`
45
+
46
+ ---
47
+
48
+ ### `interpro_get_entry` <sub>tool</sub>
49
+
50
+ - `accession` required; `sourceDatabase` is inferred from standard accession prefixes when omitted. A set accession (`CL…`) fails as `entry_not_found` and points to `interpro_get_clan`
51
+ - Wikipedia thumbnails are omitted unless `includeThumbnail: true`, and a notice reports what was left out
52
+ - A withdrawn record fails as `entry_withdrawn` with its deletion date and short name
53
+
54
+ ---
55
+
56
+ ### `interpro_get_protein_domains` <sub>tool</sub>
57
+
58
+ - Canonical six- or ten-character UniProt `accession` (no isoform suffix); optional `residuePosition` (1-based, inclusive) keeps every match with a fragment covering it, with all of that match's fragments intact; `includeExtraFeatures` adds predicted features such as disorder and transmembrane regions
59
+ - Large maps arrive in segments of whole matches within a 100,000-byte response budget, following `coverage.nextCursor` until `hasMore` is `false`. The first segment carries the protein metadata, and an empty segment cannot establish that nothing is annotated
60
+ - Discontinuous fragments, models, and upstream scores are kept as returned; `residue_out_of_range` and `protein_not_found` are typed failures
61
+
62
+ ---
63
+
64
+ ### `interpro_get_clan` <sub>tool</sub>
65
+
66
+ - `accession` for a Pfam (`CL0016`), CDD (`cl21453`), or PIRSF (`PIRSF000047`) set, with `sourceDatabase` (`pfam`, `cdd`, `pirsf`) inferred from the prefix; members page by `cursor`, `limit` 1-100 (default 20)
67
+ - `includeRelationships: true` adds the relationship graph in slices that fit the response budget; `relationshipsPage.nextOffset` goes back in as `relationshipOffset`, which needs `includeRelationships` set
68
+ - `includeThumbnail` works as on `interpro_get_entry`; a missing set is `clan_not_found`
69
+
70
+ ---
71
+
72
+ ### `interpro_find_proteins_by_domain` <sub>tool</sub>
73
+
74
+ - `accession` plus optional `sourceDatabase`; `taxonId` (NCBI, default `9606`) and `reviewedOnly` (default `true`; `false` covers reviewed and unreviewed proteins) are echoed in `query`
75
+ - Cursor-paged, `limit` 1-50 (default 20); each result keeps the protein summary, matched entry locations, and taxon lineage
76
+ - No hits is a success with a notice, since the API answers an unknown entry, an unknown taxon, and an empty intersection the same way
77
+
78
+ ---
79
+
80
+ ### `interpro_list_reference` <sub>tool</sub>
81
+
82
+ - `topic` required: `databases`, `entry_types`, `accession_patterns`, `taxa`, or `release`. The first four are local and make no network call; `taxa` lists common examples, not every taxon
83
+ - `release` reads the current InterPro version, date, and per-database entry counts, and fails as `release_changed` if the two upstream responses disagree on the version
84
+
85
+ ## Features
86
+
87
+ 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.
88
+
89
+ InterPro-specific:
90
+
91
+ - 15 database slugs (`interpro`, `pfam`, `prosite`, `profile`, `smart`, `cdd`, `panther`, `cathgene3d`, `ssf`, `ncbifam`, `hamap`, `prints`, `pirsf`, `sfld`, `antifam`) and 11 entry types, with the entry database inferred from standard accession prefixes and conflicting routes rejected locally
92
+ - One process-wide request pacer at one upstream request per second, a 50-second budget per tool call covering pacing, retries, and every request, and a 4 MiB cap on upstream responses
93
+ - Upstream HTTP/1.1 client that handles the API's bodyless 204 responses, which native `fetch` rejects on Node
94
+ - Sparse upstream metadata passes through as `null` or omitted rather than filled in
95
+
96
+ Agent-friendly output:
97
+
98
+ - `content[]` carries the complete output as compact JSON plus an index of every URL as a link and every image as an image, so clients that read only one surface get the same data
99
+ - Opaque cursors bound to their query, with a notice naming the exact next call whenever a result is partial
100
+ - Typed failure reasons (`entry_not_found`, `invalid_cursor`, `upstream_rate_limited`, and others) each paired with a recovery hint
101
+ - Coordinates describe sequence annotation, not pathogenicity or clinical significance
102
+
103
+ ## Getting started
104
+
105
+ Add the following to your MCP client configuration file. No API key is needed.
106
+
107
+ ```json
108
+ {
109
+ "mcpServers": {
110
+ "interpro-mcp-server": {
111
+ "type": "stdio",
112
+ "command": "bunx",
113
+ "args": ["@cyanheads/interpro-mcp-server@latest"],
114
+ "env": {
115
+ "MCP_TRANSPORT_TYPE": "stdio",
116
+ "MCP_LOG_LEVEL": "info"
117
+ }
118
+ }
119
+ }
120
+ }
121
+ ```
122
+
123
+ Or with npx (no Bun required):
124
+
125
+ ```json
126
+ {
127
+ "mcpServers": {
128
+ "interpro-mcp-server": {
129
+ "type": "stdio",
130
+ "command": "npx",
131
+ "args": ["-y", "@cyanheads/interpro-mcp-server@latest"],
132
+ "env": {
133
+ "MCP_TRANSPORT_TYPE": "stdio",
134
+ "MCP_LOG_LEVEL": "info"
135
+ }
136
+ }
137
+ }
138
+ }
139
+ ```
140
+
141
+ Or with Docker:
142
+
143
+ ```json
144
+ {
145
+ "mcpServers": {
146
+ "interpro-mcp-server": {
147
+ "type": "stdio",
148
+ "command": "docker",
149
+ "args": ["run", "-i", "--rm", "-e", "MCP_TRANSPORT_TYPE=stdio", "ghcr.io/cyanheads/interpro-mcp-server:latest"]
150
+ }
151
+ }
152
+ }
153
+ ```
154
+
155
+ For Streamable HTTP, set the transport and start the server:
156
+
157
+ ```sh
158
+ MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 bun run start:http
159
+ # Server listens at http://localhost:3010/mcp
160
+ ```
161
+
162
+ ### Prerequisites
163
+
164
+ - [Bun v1.4.0](https://bun.sh/) or higher (or Node.js v24+).
165
+
166
+ ### Installation
167
+
168
+ 1. **Clone the repository:**
169
+
170
+ ```sh
171
+ git clone https://github.com/cyanheads/interpro-mcp-server.git
172
+ ```
173
+
174
+ 2. **Navigate into the directory:**
175
+
176
+ ```sh
177
+ cd interpro-mcp-server
178
+ ```
179
+
180
+ 3. **Install dependencies:**
181
+
182
+ ```sh
183
+ bun install
184
+ ```
185
+
186
+ 4. **Configure environment (optional):**
187
+
188
+ ```sh
189
+ cp .env.example .env
190
+ ```
191
+
192
+ ## Configuration
193
+
194
+ The server defines no variables of its own; the InterPro API is keyless. These framework variables are the ones most often set:
195
+
196
+ | Variable | Description | Default |
197
+ |:---|:---|:---|
198
+ | `MCP_TRANSPORT_TYPE` | Transport: `stdio` or `http`. | `stdio` |
199
+ | `MCP_HTTP_PORT` | HTTP server port. | `3010` |
200
+ | `MCP_HTTP_HOST` | HTTP server host. | `127.0.0.1` |
201
+ | `MCP_HTTP_ENDPOINT_PATH` | HTTP endpoint path. | `/mcp` |
202
+ | `MCP_SESSION_MODE` | HTTP session mode: `stateless`, `stateful`, or `auto`. | `stateless` |
203
+ | `MCP_AUTH_MODE` | Authentication: `none`, `jwt`, or `oauth`. With auth on, each tool requires its `tool:<tool_name>:read` scope. | `none` |
204
+ | `MCP_LOG_LEVEL` | Log level (`debug`, `info`, `notice`, `warning`, `error`). | `info` |
205
+ | `LOGS_DIR` | Directory for log files (Node.js only). | `<app-root>/logs` |
206
+ | `STORAGE_PROVIDER_TYPE` | Storage backend: `in-memory`, `filesystem`, `supabase`, `cloudflare-kv/r2/d1`. | `in-memory` |
207
+ | `OTEL_ENABLED` | Enable [OpenTelemetry](https://github.com/cyanheads/mcp-ts-core/tree/main/docs/telemetry). | `false` |
208
+
209
+ See [`.env.example`](./.env.example) for the common framework overrides.
210
+
211
+ ## Running the server
212
+
213
+ ### Local development
214
+
215
+ - **Build and run the production version**:
216
+
217
+ ```sh
218
+ # One-time build
219
+ bun run rebuild
220
+
221
+ # Run the built server
222
+ bun run start:http
223
+ # or
224
+ bun run start:stdio
225
+ ```
226
+
227
+ - **Run checks and tests**:
228
+ ```sh
229
+ bun run devcheck # Lints, formats, type-checks, and more
230
+ bun run test # Runs the test suite
231
+ ```
232
+
233
+ ## Project structure
234
+
235
+ | Directory | Purpose |
236
+ |:---|:---|
237
+ | `src/index.ts` | `createApp()` entry point: registers the tools and starts the InterPro service. |
238
+ | `src/mcp-server/tools` | Tool definitions (`*.tool.ts`). Six tools. |
239
+ | `src/services/interpro` | InterPro service: HTTP/1.1 adapter, pacer and deadlines, accession routing, cursors, schemas, and the shared result formatter. |
240
+ | `tests/` | Unit and integration tests, mirroring the `src/` structure. |
241
+
242
+ ## Development guide
243
+
244
+ See [`CLAUDE.md`](./CLAUDE.md) for development guidelines and architectural rules. The short version:
245
+
246
+ - Handlers throw, framework catches, with no `try/catch` in tool logic
247
+ - Use `ctx.log` for request-scoped logging
248
+ - Register new tools in the `createApp()` array in `src/index.ts`
249
+ - Wrap external API calls: validate raw, normalize to the domain type, return the output schema; never fabricate missing fields
250
+
251
+ ## Contributing
252
+
253
+ Issues are welcome. Run checks and tests before submitting:
254
+
255
+ ```sh
256
+ bun run devcheck
257
+ bun run test
258
+ ```
259
+
260
+ ## License
261
+
262
+ This project is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details.
263
+
264
+ Data comes from InterPro and its member databases through the EMBL-EBI API. Licensing varies by member database, so attribute InterPro and the originating database; see [InterPro's license page](https://interpro-documentation.readthedocs.io/en/latest/license.html) and the [EMBL-EBI terms of use](https://www.ebi.ac.uk/about/terms-of-use/).
@@ -0,0 +1,20 @@
1
+ ---
2
+ summary: "First public release: six read-only tools for InterPro entries, protein domain maps, and clans over the keyless EMBL-EBI InterPro API, with 100 KB response budgets that continue by whole record, on STDIO or Streamable HTTP."
3
+ breaking: false
4
+ security: false
5
+ ---
6
+
7
+ # 0.1.1 — 2026-10-21
8
+
9
+ ## Added
10
+
11
+ - **`interpro_search_entries`** and **`interpro_get_entry`** search InterPro and 14 member databases (Pfam, PROSITE, SMART, CDD, PANTHER, and others) by text, entry type, GO annotation, or integrating InterPro accession, and read one entry's full metadata. The entry database is inferred from standard accession prefixes.
12
+ - **`interpro_get_protein_domains`** maps a UniProt protein's domains, families, repeats, and functional sites to residue coordinates, optionally at one residue or with predicted features. Discontinuous fragments, models, and upstream scores are kept as returned.
13
+ - **`interpro_get_clan`** reads a Pfam, CDD, or PIRSF set, pages its members, and optionally returns its relationship graph.
14
+ - **`interpro_find_proteins_by_domain`** finds UniProt proteins carrying an entry, defaulting to reviewed human proteins (`taxonId` and `reviewedOnly` change the scope).
15
+ - **`interpro_list_reference`** decodes database slugs, entry types, accession patterns, common taxon IDs, and the current InterPro release.
16
+ - **Response budgets**: results over 100,000 bytes are cut between whole records (protein-map matches and clan relationship slices) and continue through opaque cursors bound to their query, with a notice naming the next call.
17
+ - **Request limits**: one upstream request per second process-wide, a 50-second budget per tool call, and a 4 MiB cap on upstream responses. The HTTP/1.1 client handles the API's bodyless 204 responses, which native `fetch` rejects on Node.
18
+ - **Rendering**: `content[]` carries the full output as compact JSON plus an index of every URL and image, matching `structuredContent`. Upstream text never shapes server-written Markdown or error lines.
19
+ - **Typed failures** (`entry_not_found`, `entry_withdrawn`, `invalid_cursor`, `upstream_rate_limited`, and others), each with a recovery hint.
20
+ - **Transports**: STDIO or Streamable HTTP, stateless sessions, no API key or server-specific environment variables.
@@ -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
+ - -->
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env node
2
+ /**
3
+ * @fileoverview interpro-mcp-server MCP server entry point.
4
+ * @module index
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;GAGG"}