@jsondb-cloud/mcp 1.0.8 → 1.0.9
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 +154 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# @jsondb-cloud/mcp
|
|
2
|
+
|
|
3
|
+
The official MCP (Model Context Protocol) server for [jsondb.cloud](https://jsondb.cloud) — a hosted JSON document database. Lets AI agents create, query, and manage documents through natural language.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@jsondb-cloud/mcp)
|
|
6
|
+
[](https://www.npmjs.com/package/@jsondb-cloud/mcp)
|
|
7
|
+
[](https://github.com/JsonDBCloud/mcp/actions)
|
|
8
|
+
[](https://nodejs.org)
|
|
9
|
+
[](https://opensource.org/licenses/MIT)
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @jsondb-cloud/mcp
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Once configured, ask your AI assistant:
|
|
20
|
+
|
|
21
|
+
> List all collections in my database
|
|
22
|
+
|
|
23
|
+
> Create a document in "users" with name "Alice" and role "admin"
|
|
24
|
+
|
|
25
|
+
> Find all users where role is "admin"
|
|
26
|
+
|
|
27
|
+
> Show me version history for document abc123 in "orders"
|
|
28
|
+
|
|
29
|
+
> Set up a webhook on "orders" that fires on document.created
|
|
30
|
+
|
|
31
|
+
## Configuration
|
|
32
|
+
|
|
33
|
+
You need a jsondb.cloud API key. Get one from your [dashboard](https://jsondb.cloud).
|
|
34
|
+
|
|
35
|
+
### Claude Desktop
|
|
36
|
+
|
|
37
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"mcpServers": {
|
|
42
|
+
"jsondb": {
|
|
43
|
+
"command": "npx",
|
|
44
|
+
"args": ["-y", "@jsondb-cloud/mcp"],
|
|
45
|
+
"env": {
|
|
46
|
+
"JSONDB_API_KEY": "jdb_sk_live_..."
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Claude Code
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
claude mcp add jsondb -- npx -y @jsondb-cloud/mcp \
|
|
57
|
+
--env JSONDB_API_KEY=jdb_sk_live_...
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Cursor
|
|
61
|
+
|
|
62
|
+
Add to `.cursor/mcp.json`:
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"mcpServers": {
|
|
67
|
+
"jsondb": {
|
|
68
|
+
"command": "npx",
|
|
69
|
+
"args": ["-y", "@jsondb-cloud/mcp"],
|
|
70
|
+
"env": {
|
|
71
|
+
"JSONDB_API_KEY": "jdb_sk_live_..."
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Environment Variables
|
|
79
|
+
|
|
80
|
+
| Variable | Required | Default | Description |
|
|
81
|
+
|----------|----------|---------|-------------|
|
|
82
|
+
| `JSONDB_API_KEY` | Yes | — | API key (`jdb_sk_live_...` or `jdb_sk_test_...`) |
|
|
83
|
+
| `JSONDB_PROJECT` | No | `v1` | Project namespace |
|
|
84
|
+
| `JSONDB_BASE_URL` | No | `https://api.jsondb.cloud` | API base URL |
|
|
85
|
+
|
|
86
|
+
## Tools
|
|
87
|
+
|
|
88
|
+
### Documents
|
|
89
|
+
|
|
90
|
+
| Tool | Description |
|
|
91
|
+
|------|-------------|
|
|
92
|
+
| `create_document` | Create a new document in a collection |
|
|
93
|
+
| `get_document` | Read a single document by ID |
|
|
94
|
+
| `list_documents` | List documents with filtering, sorting, and pagination |
|
|
95
|
+
| `update_document` | Replace a document entirely |
|
|
96
|
+
| `patch_document` | Partially update a document (merge patch) |
|
|
97
|
+
| `delete_document` | Delete a document by ID |
|
|
98
|
+
| `count_documents` | Count documents matching an optional filter |
|
|
99
|
+
| `json_patch_document` | Apply RFC 6902 JSON Patch operations |
|
|
100
|
+
|
|
101
|
+
### Collections
|
|
102
|
+
|
|
103
|
+
| Tool | Description |
|
|
104
|
+
|------|-------------|
|
|
105
|
+
| `list_collections` | List all collections in the current project |
|
|
106
|
+
| `search_documents` | Search with advanced filters (`eq`, `gt`, `contains`, `in`, etc.) |
|
|
107
|
+
| `import_documents` | Bulk import with conflict resolution (`fail`, `skip`, `overwrite`) |
|
|
108
|
+
| `export_collection` | Export all documents as JSON |
|
|
109
|
+
|
|
110
|
+
### Schemas
|
|
111
|
+
|
|
112
|
+
| Tool | Description |
|
|
113
|
+
|------|-------------|
|
|
114
|
+
| `get_schema` | Get the JSON Schema for a collection |
|
|
115
|
+
| `set_schema` | Set a JSON Schema to enforce document structure |
|
|
116
|
+
| `remove_schema` | Remove schema validation from a collection |
|
|
117
|
+
| `validate_document` | Dry-run validate a document against the schema |
|
|
118
|
+
|
|
119
|
+
### Versions
|
|
120
|
+
|
|
121
|
+
| Tool | Description |
|
|
122
|
+
|------|-------------|
|
|
123
|
+
| `list_versions` | List all stored versions of a document |
|
|
124
|
+
| `get_version` | Retrieve a specific version snapshot |
|
|
125
|
+
| `restore_version` | Restore a document to a previous version |
|
|
126
|
+
| `diff_versions` | Compare two versions with a structured diff |
|
|
127
|
+
|
|
128
|
+
### Webhooks
|
|
129
|
+
|
|
130
|
+
| Tool | Description |
|
|
131
|
+
|------|-------------|
|
|
132
|
+
| `create_webhook` | Register a webhook for collection events |
|
|
133
|
+
| `list_webhooks` | List all webhooks for a collection |
|
|
134
|
+
| `get_webhook` | Get webhook details and recent delivery history |
|
|
135
|
+
| `update_webhook` | Update webhook URL, events, or status |
|
|
136
|
+
| `delete_webhook` | Delete a webhook |
|
|
137
|
+
| `test_webhook` | Send a test event to verify delivery |
|
|
138
|
+
|
|
139
|
+
## Documentation
|
|
140
|
+
|
|
141
|
+
Full documentation at [jsondb.cloud/docs](https://jsondb.cloud/docs).
|
|
142
|
+
|
|
143
|
+
## Related Packages
|
|
144
|
+
|
|
145
|
+
| Package | Description |
|
|
146
|
+
|---------|-------------|
|
|
147
|
+
| [@jsondb-cloud/client](https://github.com/JsonDBCloud/node) | JavaScript/TypeScript SDK |
|
|
148
|
+
| [@jsondb-cloud/mcp](https://github.com/JsonDBCloud/mcp) | MCP server for AI agents |
|
|
149
|
+
| [@jsondb-cloud/cli](https://github.com/JsonDBCloud/cli) | CLI tool |
|
|
150
|
+
| [jsondb-cloud](https://github.com/JsonDBCloud/python) (PyPI) | Python SDK |
|
|
151
|
+
|
|
152
|
+
## License
|
|
153
|
+
|
|
154
|
+
MIT
|
package/package.json
CHANGED