JSONPad docs, API, SDK and CLI references, and offline checkers for write rules and flows.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Compile a flow document (flows-v1) with the same engine the API uses, and run its tests (flow-tests-v1) against in-memory data. Returns diagnostics (with JSON pointers into the document), what the flow reads and writes, and why each failing test failed. Costs nothing and sees no data.
The flow document
The flow tests: a flow-tests-v1 document, optional
Path names of lists that exist, so the flow using any other list is warned about
Compile a flow document (flows-v1) with the same engine the API uses, and run its tests (flow-tests-v1) against in-memory data. Returns diagnostics (with JSON pointers into the document), what the flow reads and writes, and why each failing test failed. Costs nothing and sees no data.
| Argument | Type | Description |
|---|---|---|
| flow* | any | The flow document |
| tests | any | The flow tests: a flow-tests-v1 document, optional |
| knownLists | array | Path names of lists that exist, so the flow using any other list is warned about |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"flow"
],
"properties": {
"flow": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "string"
}
],
"description": "The flow document"
},
"tests": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "string"
}
],
"description": "The flow tests: a flow-tests-v1 document, optional"
},
"knownLists": {
"type": "array",
"items": {
"type": "string"
},
"description": "Path names of lists that exist, so the flow using any other list is warned about"
}
},
"additionalProperties": false
}Compile a list's write rules with the same engine the API uses, and run their tests (a rules-tests-v1 document). Returns every diagnostic with its line and column, and for each failing test what it expected, what happened, and how each rule came out. Costs nothing and sees no data: lookups find the test document's items. Use it before saving rules.
| Argument | Type | Description |
|---|---|---|
| rules* | any | The rule text, or its lines as an array (as in a schema sync document) |
| tests | any | The rule tests: a rules-tests-v1 document ({ "tests": [...] }), optional |
| knownLists | array | Path names of lists that exist, so lookups into any other list are warned about, as the API does when rules are saved |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rules"
],
"properties": {
"rules": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The rule text, or its lines as an array (as in a schema sync document)"
},
"tests": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "string"
}
],
"description": "The rule tests: a rules-tests-v1 document ({ \"tests\": [...] }), optional"
},
"knownLists": {
"type": "array",
"items": {
"type": "string"
},
"description": "Path names of lists that exist, so lookups into any other list are warned about, as the API does when rules are saved"
}
},
"additionalProperties": false
}Check one write against a rule set, as the API would, and say whether it would be allowed, denied (403) or failed (400), which statement decided it, and (with trace) what every expression evaluated to. The write is shaped like a rule test case: action, identity, token, old, new, patch, merge, now. Costs nothing and sees no data.
| Argument | Type | Description |
|---|---|---|
| items | object | Items for lookups to find: { "<list>": { "<item id or alias>": { "data": ... } } } |
| rules* | any | The rule text, or its lines as an array (as in a schema sync document) |
| trace | boolean | Include the value of every expression |
| write* | object | The write to check |
| identities | object | Named identities the write can refer to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"rules",
"write"
],
"properties": {
"items": {
"type": "object",
"description": "Items for lookups to find: { \"<list>\": { \"<item id or alias>\": { \"data\": ... } } }",
"additionalProperties": {}
},
"rules": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The rule text, or its lines as an array (as in a schema sync document)"
},
"trace": {
"type": "boolean",
"default": false,
"description": "Include the value of every expression"
},
"write": {
"type": "object",
"required": [
"action"
],
"properties": {
"new": {
"description": "The item data after the write"
},
"now": {
"type": "string",
"description": "The time of the write, ISO 8601"
},
"old": {
"description": "The item data before the write (not for create)"
},
"merge": {
"description": "A merge applied to old, instead of new"
},
"patch": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "A JSON Patch applied to old, instead of new"
},
"token": {
"type": "object",
"description": "The API token, e.g. { \"id\": \"t1\", \"tags\": [\"writer\"] }",
"additionalProperties": {}
},
"action": {
"enum": [
"create",
"update",
"delete",
"restore"
],
"type": "string"
},
"identity": {
"description": "The identity making the write: { \"id\": \"...\" }, a key into identities, or null"
}
},
"description": "The write to check",
"additionalProperties": true
},
"identities": {
"type": "object",
"description": "Named identities the write can refer to",
"additionalProperties": {}
}
},
"additionalProperties": false
}The full contract of one REST API endpoint: parameters, headers, request body, responses and examples, and the JavaScript SDK method that calls it. Find it by id (the docs page slug, e.g. "item-restore"), by method and path (templates or concrete paths both work: "/lists/my-list/items/abc"), or by a description.
| Argument | Type | Description |
|---|---|---|
| id | string | The endpoint id, from list_api_endpoints |
| path | string | The path, e.g. /lists/{listId}/items |
| query | string | What the endpoint does, e.g. "restore a deleted item" |
| method | string | The HTTP method |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"type": "string",
"description": "The endpoint id, from list_api_endpoints"
},
"path": {
"type": "string",
"description": "The path, e.g. /lists/{listId}/items"
},
"query": {
"type": "string",
"description": "What the endpoint does, e.g. \"restore a deleted item\""
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"ANY"
],
"type": "string",
"description": "The HTTP method"
}
},
"additionalProperties": false
}The usage, arguments and options of a jsonpad command line tool (@basementuniverse/jsonpad-cli) command, and whether it works offline. Find it by name ("rules test", "jsonpad sync-schema --dry-run") or by what it does.
| Argument | Type | Description |
|---|---|---|
| name | string | The command, e.g. "sync-schema" or "jsonpad rules test" |
| query | string | What the command does, e.g. "export items to a file" |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "The command, e.g. \"sync-schema\" or \"jsonpad rules test\""
},
"query": {
"type": "string",
"description": "What the command does, e.g. \"export items to a file\""
}
},
"additionalProperties": false
}The limits of each public plan (Free, Indie, Pro, Scale): requests per month and minute, the minimum gap between requests, storage, item size, versions kept, tokens, identities, realtime connections, webhooks and flows. null means unlimited. Sizes are in bytes, rateLimit in milliseconds, prices in GBP.
| Argument | Type | Description |
|---|---|---|
| plan | string | One plan, by id or name, e.g. "free" |
| limit | string | One limit, e.g. maxItemSize |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"plan": {
"type": "string",
"description": "One plan, by id or name, e.g. \"free\""
},
"limit": {
"enum": [
"maxRequestsPerMonth",
"overdraftPercent",
"maxRequestsPerMinute",
"rateLimit",
"maxStorageBytes",
"maxLists",
"maxItemsPerList",
"maxIndexesPerList",
"maxItemSize",
"maxItemVersions",
"maxTokens",
"maxIdentities",
"maxRealtimeConnections",
"maxWebhooks",
"maxFlows"
],
"type": "string",
"description": "One limit, e.g. maxItemSize"
}
},
"additionalProperties": false
}The signature, description and example of a method in the JavaScript SDK (@basementuniverse/jsonpad-sdk) or the realtime SDK, and the REST endpoint it calls. Find it by name ("restoreItem") or by what it does.
| Argument | Type | Description |
|---|---|---|
| name | string | The method name, e.g. restoreItem |
| query | string | What the method does, e.g. "wait for an index to build" |
| package | string | Only one package |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "The method name, e.g. restoreItem"
},
"query": {
"type": "string",
"description": "What the method does, e.g. \"wait for an index to build\""
},
"package": {
"enum": [
"jsonpad-sdk",
"jsonpad-realtime-sdk"
],
"type": "string",
"description": "Only one package"
}
},
"additionalProperties": false
}List the REST API endpoints an API token can use, as method, path and title. Get one in full with get_api_endpoint.
| Argument | Type | Description |
|---|---|---|
| resource | string | Only one resource |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"resource": {
"enum": [
"lists",
"items",
"indexes",
"identities",
"tokens",
"flows",
"schema-sync"
],
"type": "string",
"description": "Only one resource"
}
},
"additionalProperties": false
}List the documentation pages by section, with a description of each: the table of contents.
| Argument | Type | Description |
|---|---|---|
| section | string | Only list one section |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"section": {
"enum": [
"guides",
"api-reference",
"lists",
"items",
"indexes",
"identities",
"tokens",
"flows",
"schema-sync",
"sdk",
"cli"
],
"type": "string",
"description": "Only list one section"
}
},
"additionalProperties": false
}What a JSONPad API error code means, its HTTP status, and the guides that explain it. Give the numeric code (10013) or the name (QUOTA_EXCEEDED), as found in an error response's "code" and "name".
| Argument | Type | Description |
|---|---|---|
| code | integer | The numeric code, e.g. 10013 |
| name | string | The name, e.g. QUOTA_EXCEEDED |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"code": {
"type": "integer",
"description": "The numeric code, e.g. 10013"
},
"name": {
"type": "string",
"description": "The name, e.g. QUOTA_EXCEEDED"
}
},
"additionalProperties": false
}Read a documentation page as markdown, or one section of it. Give a page slug ("indexing"), a /docs path, a jsonpad.io URL (with or without .md, and with an optional #anchor), "sdk/jsonpad-sdk", "sdk/jsonpad-realtime-sdk", "cli/reference" or "cli/readme". Long pages are cut at a section boundary; read on with the returned nextSection.
| Argument | Type | Description |
|---|---|---|
| page* | string | The page: a slug, path or URL |
| section | string | A heading anchor ("filtering-items") or heading text; overrides a #anchor in page |
| maxChars | integer | The most characters of markdown to return |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"page"
],
"properties": {
"page": {
"type": "string",
"minLength": 1,
"description": "The page: a slug, path or URL"
},
"section": {
"type": "string",
"description": "A heading anchor (\"filtering-items\") or heading text; overrides a #anchor in page"
},
"maxChars": {
"type": "integer",
"default": 20000,
"maximum": 100000,
"minimum": 1000,
"description": "The most characters of markdown to return"
}
},
"additionalProperties": false
}Search the JSONPad documentation, the JavaScript SDK references and the command line tool reference. Returns the best-matching sections with a snippet and their jsonpad.io URL; read one with read_doc. Exact identifiers work well: error codes and names, headers, SDK methods, CLI commands, $jsonpad-var variables, "POST /lists/{listId}/items".
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many results (1-10) |
| query* | string | What to look for |
| section | string | Only search one section: guides, api-reference (every API reference section), lists, items, indexes, identities, tokens, flows, schema-sync, sdk or cli |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"default": 5,
"maximum": 10,
"minimum": 1,
"description": "How many results (1-10)"
},
"query": {
"type": "string",
"maxLength": 200,
"minLength": 2,
"description": "What to look for"
},
"section": {
"enum": [
"guides",
"api-reference",
"lists",
"items",
"indexes",
"identities",
"tokens",
"flows",
"schema-sync",
"sdk",
"cli"
],
"type": "string",
"description": "Only search one section: guides, api-reference (every API reference section), lists, items, indexes, identities, tokens, flows, schema-sync, sdk or cli"
}
},
"additionalProperties": false
}Check a schema sync document (sync-v1) as far as possible without an account: against the JSON schema the API uses, the API's rules for keys and indexes, and every rule set and flow in it with their tests. Documents that reference files (rulesFile, flowFile and their tests) are checked too if the files' contents are given in files. What a sync would change needs the account: the API server's plan_schema_sync, or jsonpad sync-schema --dry-run.
| Argument | Type | Description |
|---|---|---|
| files | object | The contents of files the document references, keyed by the path written in the document, e.g. { "rules/games.rules": "allow ..." } |
| document* | any | The schema sync document |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"document"
],
"properties": {
"files": {
"type": "object",
"description": "The contents of files the document references, keyed by the path written in the document, e.g. { \"rules/games.rules\": \"allow ...\" }",
"additionalProperties": {
"type": "string"
}
},
"document": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "string"
}
],
"description": "The schema sync document"
}
},
"additionalProperties": false
}Check an API token's permission rules against the schema the API uses, say which rule shape a broken one was meant to be, and warn about valid rules that probably don't do what was meant (rule order, restore without view, sync-schema alone, allow "*").
| Argument | Type | Description |
|---|---|---|
| permissions* | any | The permission rules, e.g. [{ "mode": "allow", "action": "view", "resourceType": "item", "listIds": ["*"], "itemIds": ["*"] }] |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"permissions"
],
"properties": {
"permissions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
{
"type": "string"
}
],
"description": "The permission rules, e.g. [{ \"mode\": \"allow\", \"action\": \"view\", \"resourceType\": \"item\", \"listIds\": [\"*\"], \"itemIds\": [\"*\"] }]"
}
},
"additionalProperties": false
}