JSONPad documentation

io.jsonpadPublished by jsonpad.ioOfficial publisherv0.1.0Updated Oct 24, 2026

JSONPad docs, API, SDK and CLI references, and offline checkers for write rules and flows.

VerifiedStreamable HTTPWeb executableKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

JSONPad documentation server that lets an assistant search and read JSONPad docs, API, SDK and CLI references, and validate write rules, flows and sync schemas.

What you can do
Search and read documentation pages, including the JavaScript SDK and CLI references, and list the table of contents by section. Look up REST API endpoints by id, method and path, with parameters, headers, bodies, responses and examples. Get SDK method signatures and examples, and CLI command usage, arguments and options. Look up API error codes by number or name, and read plan limits for each public plan. Compile and test write rules, evaluate a single write against a rule set, check flows, validate schema sync documents, and check token permission rules.
When to use it
Useful when working with JSONPad and you need authoritative answers on its API, SDK, CLI, error codes or plan limits, or when you want to check write rules, flows, sync documents or token permissions before applying them.
Requirements
Either the remote endpoint or the local npm package run over stdio. No authentication, environment variables or headers are declared. The offline checkers need no account; some validation of documents that reference files requires those files to be supplied.
Before you install
The checking tools are described as costing nothing and seeing no data, so they are safe to run, but they only simulate the API's engine and do not apply changes. Documentation content and plan limits come from the server and may not reflect your account's actual state.

Installation

In SourceWeft

  1. Open JSONPad documentation in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/io.jsonpad%2Fdocs/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "jsonpad-documentation": {
      "type": "http",
      "url": "https://mcp.jsonpad.io/docs"
    }
  }
}

Tools

14

search_docs

Search the JSONPad docs

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".

Parameterslimitqueryrequiredsection

read_doc

Read a JSONPad docs page

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.

ParameterspagerequiredsectionmaxChars

list_docs

List the JSONPad docs pages

List the documentation pages by section, with a description of each: the table of contents.

Parameterssection

list_api_endpoints

List the JSONPad API endpoints

List the REST API endpoints an API token can use, as method, path and title. Get one in full with get_api_endpoint.

Parametersresource

get_api_endpoint

Get a JSONPad API endpoint contract

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.

Parametersidpathquerymethod

get_sdk_method

Get a JSONPad SDK method

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.

Parametersnamequerypackage

get_cli_command

Get a JSONPad CLI command

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.

Parametersnamequery

lookup_error

Look up a JSONPad error

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".

Parameterscodename

get_plan_limits

Get JSONPad plan limits

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.

Parametersplanlimit

check_write_rules

Check write rules

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.

ParametersrulesrequiredtestsknownLists

eval_write_rule

Try a write against write rules

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.

Parametersitemsrulesrequiredtracewriterequiredidentities

check_flow

Check a flow

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.

ParametersflowrequiredtestsknownLists

validate_sync_document

Validate a schema sync document

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.

Parametersfilesdocumentrequired

validate_token_permissions

Validate token permissions

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 "*").

Parameterspermissionsrequired

Version history

1
  1. v0.1.0LatestOct 1, 2026

Score

75% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts

    Declare a GitHub repository with a README, or serve resource_documentation in the OAuth protected-resource metadata.

  • License10 pts

    Declare a license in the repository or the registry entry.

Other Jsonpad integrations