@webbula/mcp 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +82 -56
  2. package/package.json +3 -4
package/README.md CHANGED
@@ -13,6 +13,88 @@ every verdict comes from Webbula.
13
13
 
14
14
  ---
15
15
 
16
+ ## Installation
17
+
18
+ You need **Node.js 20+** and a **Webbula API key**. Run the published package
19
+ directly with `npx` — no clone, no build:
20
+
21
+ ```bash
22
+ # stdio (default) — for a local MCP host that spawns the server
23
+ WEBBULA_API_KEY=wb_your_key npx -y @webbula/mcp
24
+
25
+ # HTTP transport on port 4000 — for a remote/shared deployment
26
+ WEBBULA_API_KEY=wb_your_key PORT=4000 npx -y @webbula/mcp --http
27
+ ```
28
+
29
+ ### Connecting your AI tool
30
+
31
+ Every client launches the server over **stdio** and passes the key via `env`. Add
32
+ a `webbula` entry to your client's MCP config, then restart/reload the client —
33
+ the tools appear automatically.
34
+
35
+ **Claude Code** (CLI) — one command:
36
+
37
+ ```bash
38
+ claude mcp add webbula -e WEBBULA_API_KEY=wb_your_key -- npx -y @webbula/mcp
39
+ ```
40
+
41
+ **Claude Desktop** — edit `claude_desktop_config.json` (macOS: `~/Library/Application Support/Claude/`, Windows: `%APPDATA%\Claude\`):
42
+
43
+ ```json
44
+ {
45
+ "mcpServers": {
46
+ "webbula": {
47
+ "command": "npx",
48
+ "args": ["-y", "@webbula/mcp"],
49
+ "env": { "WEBBULA_API_KEY": "wb_your_key" }
50
+ }
51
+ }
52
+ }
53
+ ```
54
+
55
+ **Cursor** — same `mcpServers` block as above, in `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (per project).
56
+
57
+ **Windsurf** — same `mcpServers` block, in `~/.codeium/windsurf/mcp_config.json`.
58
+
59
+ **VS Code** (Copilot agent mode) — in `.vscode/mcp.json`; note the key is `servers` and each entry needs a `type`:
60
+
61
+ ```json
62
+ {
63
+ "servers": {
64
+ "webbula": {
65
+ "type": "stdio",
66
+ "command": "npx",
67
+ "args": ["-y", "@webbula/mcp"],
68
+ "env": { "WEBBULA_API_KEY": "wb_your_key" }
69
+ }
70
+ }
71
+ }
72
+ ```
73
+
74
+ ---
75
+
76
+ ## Configuration
77
+
78
+ The package is configured entirely through the **environment** — nothing else is
79
+ required. The API key is held in memory for the duration of a request only; it is
80
+ never logged, persisted, or returned in any tool output or error.
81
+
82
+ | Variable | Default | Purpose |
83
+ |----------|---------|---------|
84
+ | `WEBBULA_API_KEY` | — | **Required.** Your Webbula API key. Sent upstream as the `X-API-KEY` header. |
85
+ | `PORT` | `3000` | Listen port for the HTTP transport. |
86
+
87
+ The same tool set runs under two transports (stdio or HTTP); the transport is
88
+ chosen at launch (default stdio, `--http` for HTTP), everything else comes from
89
+ the environment.
90
+
91
+ > **Authentication model.** The key is configured **once, on the server
92
+ > process**, and every request uses it. The HTTP transport does **not** read a
93
+ > per-request `Authorization` / `X-API-KEY` header from inbound clients — run one
94
+ > server instance per key (per tenant, if you need multiple keys).
95
+
96
+ ---
97
+
16
98
  ## Tools
17
99
 
18
100
  7 tools available today, plus 4 data-append tools **coming soon** (🔜). Every tool
@@ -89,62 +171,6 @@ the tools above.
89
171
 
90
172
  ---
91
173
 
92
- ## Configuration
93
-
94
- The package is configured entirely through the **environment** — nothing else is
95
- required. The API key is held in memory for the duration of a request only; it is
96
- never logged, persisted, or returned in any tool output or error.
97
-
98
- | Variable | Default | Purpose |
99
- |----------|---------|---------|
100
- | `WEBBULA_API_KEY` | — | **Required.** Your Webbula API key. Sent upstream as the `X-API-KEY` header. |
101
- | `PORT` | `3000` | Listen port for the HTTP transport. |
102
-
103
- ### Applying the configuration
104
-
105
- The same tool set runs under two transports; the transport is chosen at launch,
106
- everything else comes from the environment.
107
-
108
- ```bash
109
- # stdio (default) — for a local MCP host that spawns the server
110
- WEBBULA_API_KEY=wb_your_key npx -y @webbula/mcp
111
-
112
- # HTTP transport on port 4000 — for a remote/shared deployment
113
- WEBBULA_API_KEY=wb_your_key PORT=4000 npx -y @webbula/mcp --http
114
- ```
115
-
116
- Most MCP hosts launch the server over stdio and inject the key via `env`
117
- (Claude Desktop `claude_desktop_config.json` example):
118
-
119
- ```json
120
- {
121
- "mcpServers": {
122
- "webbula": {
123
- "command": "npx",
124
- "args": ["-y", "@webbula/mcp"],
125
- "env": {
126
- "WEBBULA_API_KEY": "wb_your_key"
127
- }
128
- }
129
- }
130
- }
131
- ```
132
-
133
- Step-by-step, per-client guides:
134
-
135
- - [Claude Desktop](./docs/configuration-claude.md)
136
- - [VS Code](./docs/configuration-vscode.md)
137
- - [Cursor](./docs/configuration-cursor.md)
138
-
139
- ### Notes
140
-
141
- - **Authentication model.** The key is configured **once, on the server
142
- process**, and every request uses it. The HTTP transport does **not** read a
143
- per-request `Authorization` / `X-API-KEY` header from inbound clients — run one
144
- server instance per key (per tenant, if you need multiple keys).
145
-
146
- ---
147
-
148
174
  ## License
149
175
 
150
176
  MIT © Webbula, LLC
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webbula/mcp",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Webbula MCP Server — email verification, hygiene, and data-quality trust layer for AI agents",
5
5
  "homepage": "https://github.com/webbula/webbula-mcp#readme",
6
6
  "bugs": {
@@ -21,11 +21,10 @@
21
21
  "dist"
22
22
  ],
23
23
  "publishConfig": {
24
- "access": "public",
25
- "provenance": true
24
+ "access": "public"
26
25
  },
27
26
  "engines": {
28
- "node": ">=18"
27
+ "node": ">=20"
29
28
  },
30
29
  "keywords": [
31
30
  "mcp",