@openbeam/mcp-server 0.1.1 → 0.1.3
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 +98 -0
- package/dist/README.md +98 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# @openbeam/mcp-server
|
|
2
|
+
|
|
3
|
+
Enterprise knowledge MCP server for Claude, Cursor, Windsurf, Codex, and any MCP-compatible AI host.
|
|
4
|
+
|
|
5
|
+
103+ enterprise connectors. Hybrid search. RAG answers. Agent execution. All via MCP.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
### Claude Desktop
|
|
10
|
+
|
|
11
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"mcpServers": {
|
|
16
|
+
"openbeam": {
|
|
17
|
+
"command": "npx",
|
|
18
|
+
"args": ["@openbeam/mcp-server"],
|
|
19
|
+
"env": {
|
|
20
|
+
"MCP_API_KEY": "your-api-key",
|
|
21
|
+
"DATABASE_URL": "your-database-url"
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Cursor
|
|
29
|
+
|
|
30
|
+
Add to `.cursor/mcp.json`:
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"mcpServers": {
|
|
35
|
+
"openbeam": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": ["@openbeam/mcp-server"],
|
|
38
|
+
"env": {
|
|
39
|
+
"MCP_API_KEY": "your-api-key",
|
|
40
|
+
"DATABASE_URL": "your-database-url"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Claude Code
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude mcp add openbeam npx @openbeam/mcp-server
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Windsurf / Codex / Any MCP Host
|
|
54
|
+
|
|
55
|
+
Use stdio transport:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx @openbeam/mcp-server
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Environment variables:
|
|
62
|
+
|
|
63
|
+
- `MCP_API_KEY` — API key for authentication
|
|
64
|
+
- `DATABASE_URL` — PostgreSQL connection string
|
|
65
|
+
- `REDIS_URL` — Redis connection string (optional, for rate limiting)
|
|
66
|
+
- `VESPA_URL` — Vespa search endpoint
|
|
67
|
+
|
|
68
|
+
## Available Tools
|
|
69
|
+
|
|
70
|
+
| Tool | Description |
|
|
71
|
+
|------|-------------|
|
|
72
|
+
| `search_documents` | Hybrid semantic + keyword search across 103+ connectors |
|
|
73
|
+
| `search_people` | Find experts by name, email, department, or expertise |
|
|
74
|
+
| `get_document` | Retrieve full document content by ID |
|
|
75
|
+
| `get_related` | Find related documents by semantic similarity or graph |
|
|
76
|
+
| `ask_question` | RAG-powered Q&A with citations |
|
|
77
|
+
| `run_agent` | Start an autonomous agent (async, returns job_id) |
|
|
78
|
+
| `deep_research` | Multi-step research pipeline (async, returns job_id) |
|
|
79
|
+
| `get_job_status` | Check status of async agent/research jobs |
|
|
80
|
+
| `list_connectors` | List connected data sources |
|
|
81
|
+
| `get_connector_stats` | Get sync statistics for a connector |
|
|
82
|
+
|
|
83
|
+
## Available Resources
|
|
84
|
+
|
|
85
|
+
| URI Pattern | Description |
|
|
86
|
+
|-------------|-------------|
|
|
87
|
+
| `openbeam://resources/{teamId}/` | Synced enterprise documents |
|
|
88
|
+
| `openbeam://user/{teamId}/{userId}/memories/` | User knowledge and preferences |
|
|
89
|
+
| `openbeam://agent/{teamId}/{agentId}/skills/` | Agent capabilities |
|
|
90
|
+
| `openbeam://tools/{teamId}/` | Tool definitions and stats |
|
|
91
|
+
|
|
92
|
+
## Authentication
|
|
93
|
+
|
|
94
|
+
Three modes (checked in order):
|
|
95
|
+
|
|
96
|
+
1. **API Key** — Set `MCP_API_KEY` environment variable
|
|
97
|
+
2. **Bearer Token** — Set `MCP_TOKEN` environment variable
|
|
98
|
+
3. **Environment** — Set `MCP_TEAM_ID` + `MCP_USER_ID` (local dev only)
|
package/dist/README.md
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# @openbeam/mcp-server
|
|
2
|
+
|
|
3
|
+
Enterprise knowledge MCP server for Claude, Cursor, Windsurf, Codex, and any MCP-compatible AI host.
|
|
4
|
+
|
|
5
|
+
103+ enterprise connectors. Hybrid search. RAG answers. Agent execution. All via MCP.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
### Claude Desktop
|
|
10
|
+
|
|
11
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"mcpServers": {
|
|
16
|
+
"openbeam": {
|
|
17
|
+
"command": "npx",
|
|
18
|
+
"args": ["@openbeam/mcp-server"],
|
|
19
|
+
"env": {
|
|
20
|
+
"MCP_API_KEY": "your-api-key",
|
|
21
|
+
"DATABASE_URL": "your-database-url"
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Cursor
|
|
29
|
+
|
|
30
|
+
Add to `.cursor/mcp.json`:
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"mcpServers": {
|
|
35
|
+
"openbeam": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": ["@openbeam/mcp-server"],
|
|
38
|
+
"env": {
|
|
39
|
+
"MCP_API_KEY": "your-api-key",
|
|
40
|
+
"DATABASE_URL": "your-database-url"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Claude Code
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude mcp add openbeam npx @openbeam/mcp-server
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Windsurf / Codex / Any MCP Host
|
|
54
|
+
|
|
55
|
+
Use stdio transport:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx @openbeam/mcp-server
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Environment variables:
|
|
62
|
+
|
|
63
|
+
- `MCP_API_KEY` — API key for authentication
|
|
64
|
+
- `DATABASE_URL` — PostgreSQL connection string
|
|
65
|
+
- `REDIS_URL` — Redis connection string (optional, for rate limiting)
|
|
66
|
+
- `VESPA_URL` — Vespa search endpoint
|
|
67
|
+
|
|
68
|
+
## Available Tools
|
|
69
|
+
|
|
70
|
+
| Tool | Description |
|
|
71
|
+
|------|-------------|
|
|
72
|
+
| `search_documents` | Hybrid semantic + keyword search across 103+ connectors |
|
|
73
|
+
| `search_people` | Find experts by name, email, department, or expertise |
|
|
74
|
+
| `get_document` | Retrieve full document content by ID |
|
|
75
|
+
| `get_related` | Find related documents by semantic similarity or graph |
|
|
76
|
+
| `ask_question` | RAG-powered Q&A with citations |
|
|
77
|
+
| `run_agent` | Start an autonomous agent (async, returns job_id) |
|
|
78
|
+
| `deep_research` | Multi-step research pipeline (async, returns job_id) |
|
|
79
|
+
| `get_job_status` | Check status of async agent/research jobs |
|
|
80
|
+
| `list_connectors` | List connected data sources |
|
|
81
|
+
| `get_connector_stats` | Get sync statistics for a connector |
|
|
82
|
+
|
|
83
|
+
## Available Resources
|
|
84
|
+
|
|
85
|
+
| URI Pattern | Description |
|
|
86
|
+
|-------------|-------------|
|
|
87
|
+
| `openbeam://resources/{teamId}/` | Synced enterprise documents |
|
|
88
|
+
| `openbeam://user/{teamId}/{userId}/memories/` | User knowledge and preferences |
|
|
89
|
+
| `openbeam://agent/{teamId}/{agentId}/skills/` | Agent capabilities |
|
|
90
|
+
| `openbeam://tools/{teamId}/` | Tool definitions and stats |
|
|
91
|
+
|
|
92
|
+
## Authentication
|
|
93
|
+
|
|
94
|
+
Three modes (checked in order):
|
|
95
|
+
|
|
96
|
+
1. **API Key** — Set `MCP_API_KEY` environment variable
|
|
97
|
+
2. **Bearer Token** — Set `MCP_TOKEN` environment variable
|
|
98
|
+
3. **Environment** — Set `MCP_TEAM_ID` + `MCP_USER_ID` (local dev only)
|
package/package.json
CHANGED