prometiam-risk-mcp 0.2.3 → 0.2.4

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 CHANGED
@@ -1,177 +1,177 @@
1
- # `prometiam-risk-mcp`
2
-
3
- > Model Context Protocol server for the **Prometiam Risk Intelligence API** — EU + UK company-registry data, sanctions screening, and corporate-event monitoring as native MCP tools for Claude Desktop, Cursor, Continue, Cline, and any MCP-compatible client.
4
-
5
- [![npm version](https://img.shields.io/npm/v/prometiam-risk-mcp.svg)](https://www.npmjs.com/package/prometiam-risk-mcp)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
- [![OpenAPI](https://img.shields.io/badge/OpenAPI-3.0-green)](https://www.prometiam.com/openapi.json)
8
-
9
- ## What you get
10
-
11
- 26 MCP tools that wrap the [Prometiam Risk API](https://www.prometiam.com/risk-api/docs):
12
-
13
- | Tool | Description |
14
- |---|---|
15
- | `companies_search` | Search EU + UK companies by name, NIF (ES), SIREN/SIRET (FR), or company_number (UK). |
16
- | `company_detail` | Full company profile by Prometiam ID — officers, registry coordinates, capital, status. |
17
- | `events_search` | Search normalized corporate events: capital changes, director changes, dissolutions, mergers, insolvency. |
18
- | `events_timeline` | Chronological event history for one company (oldest first). |
19
- | `event_detail` | A single corporate-event record by ID, with before/after values and source notice. |
20
- | `people_search` | Search officers / directors / shareholders by name across registries. |
21
- | `person_detail` | Officer / director profile with full appointment history across companies. |
22
- | `directors_network` | Cross-directorship rollup — people appointed to many companies (nominee/hub detection, ES). |
23
- | `sanctions_screen` | Trigram-fuzzy match against five sanctions lists: EU consolidated, UN, OFAC, UK OFSI, and the French Registre des gels. |
24
- | `sanctions_entity` | Full detail for one sanctions entity by ID — aliases, programme, listing date. |
25
- | `vat_validate` | Validate an EU VAT number against VIES (27 EU states + XI) — returns registered name/address when valid. |
26
- | `lei_lookup` | Look up a Legal Entity Identifier in the GLEIF global register — legal name, jurisdiction, status, address. |
27
- | `lei_search` | Resolve a company name to candidate LEIs (GLEIF full-text search). |
28
- | `insolvency_search` | Search insolvency / risk notices (bankruptcies, liquidations, judgments). |
29
- | `insolvency_record` | A single insolvency / risk notice by ID, with related events. |
30
- | `notice_detail` | Registry gazette PDF metadata: edition, parse status, hash, raw text. |
31
- | `coverage` | Dataset coverage stats per country (companies, events, freshness). |
32
- | `account` | Calling key's plan, rate limits, remaining quota, and scopes. |
33
- | `monitor_list` | List companies subscribed to ongoing monitoring for this key. |
34
- | `monitor_get` | One monitored company by ID, with its alert history. |
35
- | `monitor_subscribe` | Subscribe a company to daily monitoring (events/status/sanctions → signed webhook). **Mutating.** |
36
- | `monitor_stop` | Stop monitoring a company and delete the subscription. **Mutating.** |
37
- | `prospect_companies_search` | Search companies by firmographics — sector group, NACE code, company age, employee band — for ICP / prospect-list building. |
38
- | `prospect_people_search` | Find contactable decision-makers (officers ES/FR, PSC owners GB) by seniority, department, and contact-route availability. Compliance-safe. |
39
- | `prospect_company_contacts` | Compliance-safe contact routes (role/company emails, phone, website, LinkedIn) published by the organisation. Suppression-filtered. |
40
- | `prospect_suppress` | Add an email/domain/LinkedIn/phone/person/company to the prospecting opt-out list (GDPR). **Mutating.** |
41
-
42
- Source: Spain (BORME), France (BODACC), United Kingdom (Companies House), Ireland (CRO), Poland (KRS) — 25M+ companies. Daily updates. EU data residency.
43
-
44
- ## Install
45
-
46
- ```bash
47
- npx -y prometiam-risk-mcp # one-shot run, no install needed
48
- # or
49
- npm install -g prometiam-risk-mcp # global install for the bin
50
- ```
51
-
52
- ## Configure
53
-
54
- You need a Prometiam API key. **Free tier: 1,000 calls/month, no credit card.** Sign up at <https://www.prometiam.com/signup>.
55
-
56
- Set it as an environment variable:
57
-
58
- ```bash
59
- export PROMETIAM_API_KEY="rk_live_..."
60
- ```
61
-
62
- ## Use with Claude Desktop
63
-
64
- Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
65
-
66
- ```json
67
- {
68
- "mcpServers": {
69
- "prometiam-risk": {
70
- "command": "npx",
71
- "args": ["-y", "prometiam-risk-mcp"],
72
- "env": {
73
- "PROMETIAM_API_KEY": "rk_live_your_key_here"
74
- }
75
- }
76
- }
77
- }
78
- ```
79
-
80
- Restart Claude Desktop. The 22 tools appear in the tool list. Try:
81
-
82
- > "What's the Prometiam coverage today?"
83
- > "Search for companies named Mercadona in Spain."
84
- > "Run a sanctions screen on the name Juan Perez at threshold 85."
85
- > "Build a corporate-event timeline for Inditex."
86
-
87
- ## Use with Cursor
88
-
89
- Edit `.cursor/mcp.json` in your project (or globally at `~/.cursor/mcp.json`):
90
-
91
- ```json
92
- {
93
- "mcpServers": {
94
- "prometiam-risk": {
95
- "command": "npx",
96
- "args": ["-y", "prometiam-risk-mcp"],
97
- "env": {
98
- "PROMETIAM_API_KEY": "rk_live_your_key_here"
99
- }
100
- }
101
- }
102
- }
103
- ```
104
-
105
- ## Use with Continue
106
-
107
- Add to `~/.continue/config.json` under `experimental.modelContextProtocolServers`:
108
-
109
- ```json
110
- {
111
- "experimental": {
112
- "modelContextProtocolServers": [
113
- {
114
- "transport": {
115
- "type": "stdio",
116
- "command": "npx",
117
- "args": ["-y", "prometiam-risk-mcp"],
118
- "env": { "PROMETIAM_API_KEY": "rk_live_your_key_here" }
119
- }
120
- }
121
- ]
122
- }
123
- }
124
- ```
125
-
126
- ## Use with any other MCP client
127
-
128
- Anything that speaks MCP over stdio works. Run the binary with `PROMETIAM_API_KEY` set in the environment. JSON-RPC requests on stdin, responses on stdout, logs on stderr.
129
-
130
- ## Environment variables
131
-
132
- | Variable | Required | Default |
133
- |---|---|---|
134
- | `PROMETIAM_API_KEY` | **Yes** | — |
135
- | `PROMETIAM_BASE_URL` | No | `https://api.prometiam.com/functions/v1/risk-api` |
136
-
137
- ## Smoke test
138
-
139
- Once installed and configured, you can verify the server lists tools without spinning up an MCP client:
140
-
141
- ```bash
142
- echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | PROMETIAM_API_KEY=rk_live_... npx -y prometiam-risk-mcp
143
- ```
144
-
145
- You should see a JSON-RPC response with all 22 tools and their schemas.
146
-
147
- ## Rate limits & pricing
148
-
149
- Per Prometiam tier (returned in every response's `meta.rate_limit`):
150
-
151
- | Tier | Price | Calls/month | Daily cap | RPM |
152
- |---|---|---|---|---|
153
- | Free | €0 | 1,000 | 200 | 10 |
154
- | Starter | €9.99 | 10,000 | 2,000 | 60 |
155
- | Professional | €29.99 | 100,000 | 20,000 | 300 |
156
- | Scale | €99.99 | 1,000,000 | 200,000 | 600 |
157
- | Enterprise | Custom | Custom | Custom | Custom |
158
-
159
- ## Privacy and data residency
160
-
161
- - All requests hit the Prometiam Risk API in **EU** (AWS eu-central-1, Frankfurt).
162
- - The MCP server adds **no telemetry of its own** — it just forwards requests to the API.
163
- - Officer data is processed under GDPR Article 6(1)(c) (legal obligation of public registries) and 6(1)(f) (legitimate interest in fraud prevention).
164
- - Mostly read-only. The only mutating tools are `monitor_subscribe` and `monitor_stop` (create/delete a monitoring subscription tied to your key) and `prospect_suppress` (adds a GDPR opt-out); every other tool is read-only.
165
-
166
- ## Source
167
-
168
- This package is open source under the MIT license. The Risk API itself is a commercial service — see <https://www.prometiam.com> for terms.
169
-
170
- - API documentation: <https://www.prometiam.com/risk-api/docs>
171
- - OpenAPI 3.0 spec: <https://www.prometiam.com/openapi.json>
172
- - Pricing: <https://www.prometiam.com/pricing>
173
- - Support: <https://www.prometiam.com/contact>
174
-
175
- ## License
176
-
177
- MIT © Prometiam
1
+ # `prometiam-risk-mcp`
2
+
3
+ > Model Context Protocol server for the **Prometiam company data API** — official company-registry data for Spain, France, the UK, Ireland and Poland, plus directors, corporate events, insolvency, VAT/LEI lookup and sanctions screening, as native MCP tools for Claude Desktop, Cursor, Continue, Cline, and any MCP-compatible client.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/prometiam-risk-mcp.svg)](https://www.npmjs.com/package/prometiam-risk-mcp)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+ [![OpenAPI](https://img.shields.io/badge/OpenAPI-3.0-green)](https://www.prometiam.com/openapi.json)
8
+
9
+ ## What you get
10
+
11
+ 26 MCP tools that wrap the [Prometiam Risk API](https://www.prometiam.com/risk-api/docs):
12
+
13
+ | Tool | Description |
14
+ |---|---|
15
+ | `companies_search` | Search EU + UK companies by name, NIF (ES), SIREN/SIRET (FR), or company_number (UK). |
16
+ | `company_detail` | Full company profile by Prometiam ID — officers, registry coordinates, capital, status. |
17
+ | `events_search` | Search normalized corporate events: capital changes, director changes, dissolutions, mergers, insolvency. |
18
+ | `events_timeline` | Chronological event history for one company (oldest first). |
19
+ | `event_detail` | A single corporate-event record by ID, with before/after values and source notice. |
20
+ | `people_search` | Search officers / directors / shareholders by name across registries. |
21
+ | `person_detail` | Officer / director profile with full appointment history across companies. |
22
+ | `directors_network` | Cross-directorship rollup — people appointed to many companies (nominee/hub detection, ES). |
23
+ | `sanctions_screen` | Trigram-fuzzy match against five sanctions lists: EU consolidated, UN, OFAC, UK OFSI, and the French Registre des gels. |
24
+ | `sanctions_entity` | Full detail for one sanctions entity by ID — aliases, programme, listing date. |
25
+ | `vat_validate` | Validate an EU VAT number against VIES (27 EU states + XI) — returns registered name/address when valid. |
26
+ | `lei_lookup` | Look up a Legal Entity Identifier in the GLEIF global register — legal name, jurisdiction, status, address. |
27
+ | `lei_search` | Resolve a company name to candidate LEIs (GLEIF full-text search). |
28
+ | `insolvency_search` | Search insolvency / risk notices (bankruptcies, liquidations, judgments). |
29
+ | `insolvency_record` | A single insolvency / risk notice by ID, with related events. |
30
+ | `notice_detail` | Registry gazette PDF metadata: edition, parse status, hash, raw text. |
31
+ | `coverage` | Dataset coverage stats per country (companies, events, freshness). |
32
+ | `account` | Calling key's plan, rate limits, remaining quota, and scopes. |
33
+ | `monitor_list` | List companies subscribed to ongoing monitoring for this key. |
34
+ | `monitor_get` | One monitored company by ID, with its alert history. |
35
+ | `monitor_subscribe` | Subscribe a company to daily monitoring (events/status/sanctions → signed webhook). **Mutating.** |
36
+ | `monitor_stop` | Stop monitoring a company and delete the subscription. **Mutating.** |
37
+ | `prospect_companies_search` | Search companies by firmographics — sector group, NACE code, company age, employee band — for ICP / prospect-list building. |
38
+ | `prospect_people_search` | Find contactable decision-makers (officers ES/FR, PSC owners GB) by seniority, department, and contact-route availability. Compliance-safe. |
39
+ | `prospect_company_contacts` | Compliance-safe contact routes (role/company emails, phone, website, LinkedIn) published by the organisation. Suppression-filtered. |
40
+ | `prospect_suppress` | Add an email/domain/LinkedIn/phone/person/company to the prospecting opt-out list (GDPR). **Mutating.** |
41
+
42
+ Source: Spain (BORME), France (BODACC), United Kingdom (Companies House), Ireland (CRO), Poland (KRS) — 25M+ companies. Daily updates. EU data residency.
43
+
44
+ ## Install
45
+
46
+ ```bash
47
+ npx -y prometiam-risk-mcp # one-shot run, no install needed
48
+ # or
49
+ npm install -g prometiam-risk-mcp # global install for the bin
50
+ ```
51
+
52
+ ## Configure
53
+
54
+ You need a Prometiam API key. **Free tier: 1,000 calls/month, no credit card.** Sign up at <https://www.prometiam.com/signup>.
55
+
56
+ Set it as an environment variable:
57
+
58
+ ```bash
59
+ export PROMETIAM_API_KEY="rk_live_..."
60
+ ```
61
+
62
+ ## Use with Claude Desktop
63
+
64
+ Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
65
+
66
+ ```json
67
+ {
68
+ "mcpServers": {
69
+ "prometiam-risk": {
70
+ "command": "npx",
71
+ "args": ["-y", "prometiam-risk-mcp"],
72
+ "env": {
73
+ "PROMETIAM_API_KEY": "rk_live_your_key_here"
74
+ }
75
+ }
76
+ }
77
+ }
78
+ ```
79
+
80
+ Restart Claude Desktop. The 22 tools appear in the tool list. Try:
81
+
82
+ > "What's the Prometiam coverage today?"
83
+ > "Search for companies named Mercadona in Spain."
84
+ > "Run a sanctions screen on the name Juan Perez at threshold 85."
85
+ > "Build a corporate-event timeline for Inditex."
86
+
87
+ ## Use with Cursor
88
+
89
+ Edit `.cursor/mcp.json` in your project (or globally at `~/.cursor/mcp.json`):
90
+
91
+ ```json
92
+ {
93
+ "mcpServers": {
94
+ "prometiam-risk": {
95
+ "command": "npx",
96
+ "args": ["-y", "prometiam-risk-mcp"],
97
+ "env": {
98
+ "PROMETIAM_API_KEY": "rk_live_your_key_here"
99
+ }
100
+ }
101
+ }
102
+ }
103
+ ```
104
+
105
+ ## Use with Continue
106
+
107
+ Add to `~/.continue/config.json` under `experimental.modelContextProtocolServers`:
108
+
109
+ ```json
110
+ {
111
+ "experimental": {
112
+ "modelContextProtocolServers": [
113
+ {
114
+ "transport": {
115
+ "type": "stdio",
116
+ "command": "npx",
117
+ "args": ["-y", "prometiam-risk-mcp"],
118
+ "env": { "PROMETIAM_API_KEY": "rk_live_your_key_here" }
119
+ }
120
+ }
121
+ ]
122
+ }
123
+ }
124
+ ```
125
+
126
+ ## Use with any other MCP client
127
+
128
+ Anything that speaks MCP over stdio works. Run the binary with `PROMETIAM_API_KEY` set in the environment. JSON-RPC requests on stdin, responses on stdout, logs on stderr.
129
+
130
+ ## Environment variables
131
+
132
+ | Variable | Required | Default |
133
+ |---|---|---|
134
+ | `PROMETIAM_API_KEY` | **Yes** | — |
135
+ | `PROMETIAM_BASE_URL` | No | `https://api.prometiam.com/functions/v1/risk-api` |
136
+
137
+ ## Smoke test
138
+
139
+ Once installed and configured, you can verify the server lists tools without spinning up an MCP client:
140
+
141
+ ```bash
142
+ echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | PROMETIAM_API_KEY=rk_live_... npx -y prometiam-risk-mcp
143
+ ```
144
+
145
+ You should see a JSON-RPC response with all 22 tools and their schemas.
146
+
147
+ ## Rate limits & pricing
148
+
149
+ Per Prometiam tier (returned in every response's `meta.rate_limit`):
150
+
151
+ | Tier | Price | Calls/month | Daily cap | RPM |
152
+ |---|---|---|---|---|
153
+ | Free | €0 | 1,000 | 200 | 10 |
154
+ | Starter | €9.99 | 10,000 | 2,000 | 60 |
155
+ | Professional | €29.99 | 100,000 | 20,000 | 300 |
156
+ | Scale | €99.99 | 1,000,000 | 200,000 | 600 |
157
+ | Enterprise | Custom | Custom | Custom | Custom |
158
+
159
+ ## Privacy and data residency
160
+
161
+ - All requests hit the Prometiam Risk API in **EU** (AWS eu-central-1, Frankfurt).
162
+ - The MCP server adds **no telemetry of its own** — it just forwards requests to the API.
163
+ - Officer data is processed under GDPR Article 6(1)(c) (legal obligation of public registries) and 6(1)(f) (legitimate interest in fraud prevention).
164
+ - Mostly read-only. The only mutating tools are `monitor_subscribe` and `monitor_stop` (create/delete a monitoring subscription tied to your key) and `prospect_suppress` (adds a GDPR opt-out); every other tool is read-only.
165
+
166
+ ## Source
167
+
168
+ This package is open source under the MIT license. The Risk API itself is a commercial service — see <https://www.prometiam.com> for terms.
169
+
170
+ - API documentation: <https://www.prometiam.com/risk-api/docs>
171
+ - OpenAPI 3.0 spec: <https://www.prometiam.com/openapi.json>
172
+ - Pricing: <https://www.prometiam.com/pricing>
173
+ - Support: <https://www.prometiam.com/contact>
174
+
175
+ ## License
176
+
177
+ MIT © Prometiam
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  /**
3
- * Prometiam Risk Intelligence — MCP server.
3
+ * Prometiam Company Data — MCP server.
4
4
  *
5
5
  * Exposes the Prometiam Risk API as Model Context Protocol tools so any
6
6
  * MCP-compatible client (Claude Desktop, Cursor, Continue, Cline, etc.)
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  /**
3
- * Prometiam Risk Intelligence — MCP server.
3
+ * Prometiam Company Data — MCP server.
4
4
  *
5
5
  * Exposes the Prometiam Risk API as Model Context Protocol tools so any
6
6
  * MCP-compatible client (Claude Desktop, Cursor, Continue, Cline, etc.)
@@ -37,7 +37,7 @@ async function main() {
37
37
  name: 'prometiam-risk',
38
38
  // Keep in step with package.json — this is the version MCP clients display.
39
39
  // It silently drifted to 0.2.0 while the package shipped 0.2.2.
40
- version: '0.2.3',
40
+ version: '0.2.4',
41
41
  }, {
42
42
  instructions: 'EU + UK company-registry data across 5 countries (Spain, France, the UK, Ireland, Poland), sanctions screening, and corporate-event monitoring. ' +
43
43
  'Use companies_search to find companies by name or identifier, company_detail to get full profile, ' +
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "prometiam-risk-mcp",
3
- "version": "0.2.3",
3
+ "version": "0.2.4",
4
4
  "mcpName": "io.github.matiasmaquieira96/risk-mcp",
5
- "description": "Model Context Protocol server for the Prometiam Risk Intelligence API — EU + UK company registry data, sanctions screening, and corporate-event monitoring as native MCP tools for Claude, Cursor, and any MCP-compatible client.",
5
+ "description": "Model Context Protocol server for the Prometiam company data API — official registry data for Spain, France, the UK, Ireland and Poland, plus directors and UK beneficial ownership, corporate events, insolvency notices, VAT (VIES) and LEI (GLEIF) lookup and sanctions screening, as native MCP tools for Claude, Cursor and any MCP-compatible client.",
6
6
  "type": "module",
7
7
  "main": "dist/index.js",
8
8
  "bin": {
@@ -36,7 +36,11 @@
36
36
  "bodacc",
37
37
  "companies-house",
38
38
  "eu",
39
- "uk"
39
+ "uk",
40
+ "company-data",
41
+ "company-search",
42
+ "registry-api",
43
+ "open-data"
40
44
  ],
41
45
  "author": "Prometiam <support@prometiam.com> (https://www.prometiam.com)",
42
46
  "license": "MIT",