ebi-search-mcp 1.0.0 → 1.0.2
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/README.md +18 -0
- package/dist/api.js +77 -0
- package/dist/license.js +78 -0
- package/dist/server.js +33 -1
- package/package.json +1 -1
- package/server.json +2 -2
package/README.md
CHANGED
|
@@ -19,3 +19,21 @@ node dist/index.js
|
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Data comes from the public Ebi Search API.
|
|
22
|
+
|
|
23
|
+
<!-- paywall -->
|
|
24
|
+
## Premium tools
|
|
25
|
+
|
|
26
|
+
These tools need a license key:
|
|
27
|
+
|
|
28
|
+
* `domain_info`
|
|
29
|
+
|
|
30
|
+
Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-ebi-search-mcp and set it in your MCP client config:
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
"env": { "MCP_LICENSE_KEY": "mcp_live_..." }
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The key is checked against MCP Marketplace, cached for 24 hours, and keeps
|
|
37
|
+
working offline once one check has succeeded. Every other tool on this server
|
|
38
|
+
stays free.
|
|
39
|
+
<!-- /paywall -->
|
package/dist/api.js
CHANGED
|
@@ -34,3 +34,80 @@ export async function entry(args) {
|
|
|
34
34
|
const fields = (d.fields ?? []).slice(0, 15).map((f) => `* ${f.name ?? '?'}: ${(f.value ?? '').slice(0, 120)}`);
|
|
35
35
|
return `Entry ${d.id} (${d.source ?? args.domain}):\n` + fields.join('\n');
|
|
36
36
|
}
|
|
37
|
+
async function explainFailure(res) {
|
|
38
|
+
let why = `HTTP ${res.status}`;
|
|
39
|
+
try {
|
|
40
|
+
const body = (await res.json());
|
|
41
|
+
if (body?.diagnostics?.message)
|
|
42
|
+
why = body.diagnostics.message;
|
|
43
|
+
}
|
|
44
|
+
catch {
|
|
45
|
+
// the body was not JSON, so the status code is the only reason we have
|
|
46
|
+
why = `HTTP ${res.status}`;
|
|
47
|
+
}
|
|
48
|
+
return why;
|
|
49
|
+
}
|
|
50
|
+
async function getEbi(url) {
|
|
51
|
+
const res = await fetch(url, {
|
|
52
|
+
headers: { 'User-Agent': UA, Accept: 'application/json' },
|
|
53
|
+
signal: AbortSignal.timeout(25000),
|
|
54
|
+
});
|
|
55
|
+
if (!res.ok)
|
|
56
|
+
throw new Error(`EBI Search said ${await explainFailure(res)}`);
|
|
57
|
+
return res.json();
|
|
58
|
+
}
|
|
59
|
+
export async function domainIndex(_args = {}) {
|
|
60
|
+
const data = (await getEbi(`${BASE}?format=json`));
|
|
61
|
+
const roots = data.domains ?? [];
|
|
62
|
+
if (!roots.length)
|
|
63
|
+
throw new Error('EBI Search returned no domains.');
|
|
64
|
+
const nodes = [];
|
|
65
|
+
const walk = (node, depth) => {
|
|
66
|
+
const entry = { id: node.id, name: node.name ?? '', depth, descendants: 0 };
|
|
67
|
+
nodes.push(entry);
|
|
68
|
+
for (const child of node.subdomains ?? [])
|
|
69
|
+
entry.descendants += 1 + walk(child, depth + 1);
|
|
70
|
+
return entry.descendants;
|
|
71
|
+
};
|
|
72
|
+
for (const root of roots)
|
|
73
|
+
walk(root, 0);
|
|
74
|
+
const at = (depth) => nodes.filter((n) => n.depth === depth);
|
|
75
|
+
const lines = [
|
|
76
|
+
`EBI Search holds ${nodes.length} domains in one tree, ${nodes.length - roots.length} of them below the top level.`,
|
|
77
|
+
];
|
|
78
|
+
for (const root of at(0))
|
|
79
|
+
lines.push(`${root.id}${root.name ? ` (${root.name})` : ''}`);
|
|
80
|
+
lines.push(' the groups directly below it:');
|
|
81
|
+
for (const group of at(1)) {
|
|
82
|
+
lines.push(` ${group.id}${group.name ? ` (${group.name})` : ''}: ${group.descendants} domain(s) inside`);
|
|
83
|
+
}
|
|
84
|
+
const deepest = nodes.reduce((max, n) => Math.max(max, n.depth), 0);
|
|
85
|
+
lines.push(` the tree is ${deepest + 1} level(s) deep; pass any of these ids to the search or entry tool.`);
|
|
86
|
+
return lines.join('\n');
|
|
87
|
+
}
|
|
88
|
+
export async function domainInfo(args) {
|
|
89
|
+
const domain = (args.domain ?? '').trim().toLowerCase();
|
|
90
|
+
if (!domain)
|
|
91
|
+
throw new Error('Provide a domain id like uniprot or ensembl.');
|
|
92
|
+
const data = (await getEbi(`${BASE}/${encodeURIComponent(domain)}?format=json`));
|
|
93
|
+
const d = (data.domains ?? [])[0];
|
|
94
|
+
if (!d)
|
|
95
|
+
throw new Error(`EBI Search did not describe a domain called "${domain}".`);
|
|
96
|
+
const infos = (d.indexInfos ?? []).slice(0, 12).map((i) => ` ${i.name ?? '?'}: ${i.value ?? ''}`);
|
|
97
|
+
const fields = d.fieldInfos ?? [];
|
|
98
|
+
const searchable = fields.filter((f) => (f.options ?? []).some((o) => o.name === 'searchable' && o.value === 'true'));
|
|
99
|
+
const lines = [
|
|
100
|
+
`${d.id}${d.name ? ` - ${d.name}` : ''}`,
|
|
101
|
+
d.description ? ` ${d.description.slice(0, 300)}` : ' no description reported',
|
|
102
|
+
' what EBI Search reports about this index:',
|
|
103
|
+
...infos,
|
|
104
|
+
` fields in the index: ${fields.length}, of which ${searchable.length} are marked searchable`,
|
|
105
|
+
...searchable.slice(0, 10).map((f) => ` ${f.id ?? '?'}`),
|
|
106
|
+
];
|
|
107
|
+
if (searchable.length > 10)
|
|
108
|
+
lines.push(` and ${searchable.length - 10} more`);
|
|
109
|
+
if (!fields.length)
|
|
110
|
+
lines.push(' the index reported no field list.');
|
|
111
|
+
lines.push(` query it with the search tool and the domain "${d.id}", or read one record with the entry tool.`);
|
|
112
|
+
return lines.join('\n');
|
|
113
|
+
}
|
package/dist/license.js
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
// Premium tools on this server need a license key bought from MCP Marketplace.
|
|
2
|
+
// Buyers put the key in their MCP client config as MCP_LICENSE_KEY. Every tool
|
|
3
|
+
// that is not listed in PREMIUM keeps working without a key.
|
|
4
|
+
const SLUG = "ebi-search-mcp";
|
|
5
|
+
// Tools that need a key. Everything else is free.
|
|
6
|
+
const PREMIUM = new Set([
|
|
7
|
+
"domain_info",
|
|
8
|
+
]);
|
|
9
|
+
const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`;
|
|
10
|
+
// The license check calls the marketplace's verify endpoint directly instead of
|
|
11
|
+
// using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
|
|
12
|
+
// check it makes is rejected by Supabase before it reaches the function. The
|
|
13
|
+
// publishable key below is public by design - it ships in mcp-marketplace.io's
|
|
14
|
+
// own JavaScript and only ever reaches their licence check.
|
|
15
|
+
const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key";
|
|
16
|
+
const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h";
|
|
17
|
+
const OK_CACHE_MS = 60 * 60 * 1000;
|
|
18
|
+
const BAD_CACHE_MS = 60 * 1000;
|
|
19
|
+
const seen = new Map();
|
|
20
|
+
const REASONS = {
|
|
21
|
+
missing_key: "no key is set",
|
|
22
|
+
invalid_format: "that key is not a valid MCP Marketplace key",
|
|
23
|
+
not_found: "that key was not found",
|
|
24
|
+
revoked: "that key has been revoked",
|
|
25
|
+
rotated: "that key was rotated, use your new one",
|
|
26
|
+
expired: "that key has expired, renew it",
|
|
27
|
+
rate_limited: "there were too many checks just now, try again shortly",
|
|
28
|
+
network_error: "the license server could not be reached",
|
|
29
|
+
};
|
|
30
|
+
function blocked(tool, reason) {
|
|
31
|
+
const why = REASONS[reason] ?? `the license server answered "${reason}"`;
|
|
32
|
+
return `"${tool}" needs a license key, but ${why}. ` +
|
|
33
|
+
`Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`;
|
|
34
|
+
}
|
|
35
|
+
async function verify(key) {
|
|
36
|
+
const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
|
|
37
|
+
method: "POST",
|
|
38
|
+
headers: {
|
|
39
|
+
apikey: PUBLISHABLE_KEY,
|
|
40
|
+
Authorization: `Bearer ${PUBLISHABLE_KEY}`,
|
|
41
|
+
"Content-Type": "application/json",
|
|
42
|
+
},
|
|
43
|
+
body: JSON.stringify({ key, slug: SLUG }),
|
|
44
|
+
// an unusable key answers 400 with a JSON body, so read the body either way
|
|
45
|
+
signal: AbortSignal.timeout(15000),
|
|
46
|
+
});
|
|
47
|
+
const data = (await res.json());
|
|
48
|
+
if (typeof data?.valid !== "boolean")
|
|
49
|
+
return { valid: false, reason: "unexpected_response" };
|
|
50
|
+
return data;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Returns null when the caller may run the tool, or a short message telling
|
|
54
|
+
* them how to get a key.
|
|
55
|
+
*
|
|
56
|
+
* A good key is remembered for an hour, so a busy session does not hit the
|
|
57
|
+
* license server on every call and keeps working through a brief outage.
|
|
58
|
+
*/
|
|
59
|
+
export async function premiumRequired(tool) {
|
|
60
|
+
if (!PREMIUM.has(tool))
|
|
61
|
+
return null;
|
|
62
|
+
const key = process.env.MCP_LICENSE_KEY;
|
|
63
|
+
if (!key)
|
|
64
|
+
return blocked(tool, "missing_key");
|
|
65
|
+
const hit = seen.get(key);
|
|
66
|
+
if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
|
|
67
|
+
return hit.valid ? null : blocked(tool, hit.reason ?? "invalid");
|
|
68
|
+
}
|
|
69
|
+
let result;
|
|
70
|
+
try {
|
|
71
|
+
result = await verify(key);
|
|
72
|
+
}
|
|
73
|
+
catch {
|
|
74
|
+
result = { valid: false, reason: "network_error" };
|
|
75
|
+
}
|
|
76
|
+
seen.set(key, { ...result, at: Date.now() });
|
|
77
|
+
return result.valid ? null : blocked(tool, result.reason ?? "invalid");
|
|
78
|
+
}
|
package/dist/server.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
2
|
import { z } from "zod";
|
|
3
3
|
import { entry } from "./api.js";
|
|
4
|
-
import { search } from "./api.js";
|
|
4
|
+
import { search, domainIndex, domainInfo } from "./api.js";
|
|
5
|
+
import { premiumRequired } from "./license.js";
|
|
5
6
|
const text = (value) => ({ content: [{ type: "text", text: value }] });
|
|
6
7
|
const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
|
|
7
8
|
const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
|
|
@@ -34,5 +35,36 @@ export function createServer() {
|
|
|
34
35
|
return textError(error(e));
|
|
35
36
|
}
|
|
36
37
|
});
|
|
38
|
+
server.registerTool("domain_index", {
|
|
39
|
+
title: "Domain index",
|
|
40
|
+
description: "The whole tree of databases EBI Search can query, with how many domains sit inside each group, so a caller can see what is searchable instead of guessing a domain name.",
|
|
41
|
+
inputSchema: z.object({}),
|
|
42
|
+
annotations: READ_ONLY,
|
|
43
|
+
}, async (args) => {
|
|
44
|
+
try {
|
|
45
|
+
return text(await domainIndex());
|
|
46
|
+
}
|
|
47
|
+
catch (e) {
|
|
48
|
+
return textError(error(e));
|
|
49
|
+
}
|
|
50
|
+
});
|
|
51
|
+
server.registerTool("domain_info", {
|
|
52
|
+
title: "Domain info",
|
|
53
|
+
description: "One database's own facts: the entry count and release dates EBI Search reports for it, and which of its fields are searchable. The search tool only returns results, it never describes the domain.",
|
|
54
|
+
inputSchema: z.object({ domain: z.string().describe("A domain id from the domain index, like uniprot, ensembl or literature.") }),
|
|
55
|
+
annotations: READ_ONLY,
|
|
56
|
+
}, async (args) => {
|
|
57
|
+
// ---- paywall: domain_info ----
|
|
58
|
+
const paywallMessage = await premiumRequired("domain_info");
|
|
59
|
+
if (paywallMessage)
|
|
60
|
+
return { content: [{ type: "text", text: paywallMessage }], isError: true };
|
|
61
|
+
// ---- paywall: end ----
|
|
62
|
+
try {
|
|
63
|
+
return text(await domainInfo(args));
|
|
64
|
+
}
|
|
65
|
+
catch (e) {
|
|
66
|
+
return textError(error(e));
|
|
67
|
+
}
|
|
68
|
+
});
|
|
37
69
|
return server;
|
|
38
70
|
}
|
package/package.json
CHANGED
package/server.json
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
"url": "https://github.com/mrfentmen/ebi-search-mcp",
|
|
7
7
|
"source": "github"
|
|
8
8
|
},
|
|
9
|
-
"version": "1.0.
|
|
9
|
+
"version": "1.0.1",
|
|
10
10
|
"packages": [
|
|
11
11
|
{
|
|
12
12
|
"registryType": "npm",
|
|
13
13
|
"identifier": "ebi-search-mcp",
|
|
14
|
-
"version": "1.0.
|
|
14
|
+
"version": "1.0.1",
|
|
15
15
|
"transport": {
|
|
16
16
|
"type": "stdio"
|
|
17
17
|
}
|