@marsnme/mcp-gateway 0.1.1 → 0.1.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 +61 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @marsnme/mcp-gateway
|
|
2
|
+
MarsNMe MCP Gateway for memory tools over streamable HTTP transport.
|
|
3
|
+
|
|
4
|
+
This package runs an MCP server at `POST /mcp` and exposes health status at `GET /health`.
|
|
5
|
+
|
|
6
|
+
## Requirements
|
|
7
|
+
- Node.js `>=20`
|
|
8
|
+
- Supabase project with required schema migrations applied
|
|
9
|
+
- Jina API key for embedding-based memory search
|
|
10
|
+
|
|
11
|
+
## Quick start (npx)
|
|
12
|
+
```bash
|
|
13
|
+
MCP_PROFILE=coco \
|
|
14
|
+
SUPABASE_BASE_URL=https://<your-project-ref>.supabase.co \
|
|
15
|
+
SUPABASE_SERVICE_ROLE_KEY=<your-service-role-key> \
|
|
16
|
+
JINA_API_KEY=<your-jina-api-key> \
|
|
17
|
+
npx -y @marsnme/mcp-gateway
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
After startup:
|
|
21
|
+
- Health: `http://127.0.0.1:18790/health`
|
|
22
|
+
- MCP endpoint: `http://127.0.0.1:18790/mcp`
|
|
23
|
+
|
|
24
|
+
## Required environment variables
|
|
25
|
+
- `MCP_PROFILE`
|
|
26
|
+
- Supported values: `coco` or `toto`
|
|
27
|
+
- Default: `coco`
|
|
28
|
+
- `SUPABASE_BASE_URL`
|
|
29
|
+
- Your Supabase REST project URL
|
|
30
|
+
- `SUPABASE_SERVICE_ROLE_KEY` (recommended) or `SUPABASE_SERVICE_KEY`
|
|
31
|
+
- Service role key used for database operations
|
|
32
|
+
- `JINA_API_KEY`
|
|
33
|
+
- Required for semantic search / embedding features
|
|
34
|
+
|
|
35
|
+
## Common optional environment variables
|
|
36
|
+
- `PORT`
|
|
37
|
+
- Overrides default port (`18790` for `coco`, `18791` for `toto`)
|
|
38
|
+
- `MCP_REQUIRE_BEARER`
|
|
39
|
+
- Set `true` to require `Authorization: Bearer <token>` on MCP calls
|
|
40
|
+
- `MCP_OAUTH_ENABLED`
|
|
41
|
+
- OAuth endpoints are enabled by default (set `false` to disable)
|
|
42
|
+
- `MCP_CLIENT_ID` and `MCP_CLIENT_SECRET`
|
|
43
|
+
- Optional static OAuth client credentials
|
|
44
|
+
|
|
45
|
+
## Minimal validation
|
|
46
|
+
Check service health:
|
|
47
|
+
```bash
|
|
48
|
+
curl -sS http://127.0.0.1:18790/health
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
List tools:
|
|
52
|
+
```bash
|
|
53
|
+
curl -sS http://127.0.0.1:18790/mcp \
|
|
54
|
+
-H 'content-type: application/json' \
|
|
55
|
+
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}'
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Database setup and full onboarding
|
|
59
|
+
For migrations and full setup details:
|
|
60
|
+
- Repository README: https://github.com/Marsmanleo/MarsNMe/blob/main/README.md
|
|
61
|
+
- Zero-to-first-recall onboarding: https://github.com/Marsmanleo/MarsNMe/blob/main/docs/onboarding-a-mcp-zero-to-recall.md
|