External API

URL scheme, MCP server, pairing flow, terminal, and iOS Shortcuts for driving TablePro from other apps

External API

The TablePro External API is the public contract that lets other apps drive TablePro. Raycast, Cursor, Claude Desktop, shell scripts, and DDEV all use the same surface. This page is the entry point. Pick the subpage that matches what you want to do.

Three pillars

The External API has three independent layers. Most clients use a mix of all three.

URL scheme

tablepro:// deep links open connections, tables, and queries in the GUI.

MCP server

JSON-RPC tools and resources for AI clients. HTTP and stdio transports.

Pairing

One-click flow to issue a scoped token to an extension.

Two more surfaces build on these. TablePro also opens plain database URLs (mysql://...) handed to it by macOS, which is what Terminal and DDEV uses. On iPhone and iPad, TablePro exposes App Intents for iOS Shortcuts.

When to use which

Goal	Use
Open a connection from a script or other app	URL scheme
Open a database from the shell or a DDEV project	Terminal and DDEV
Run a query and read rows back	MCP execute_query
Browse schema for an AI model	MCP list_tables, describe_table
Issue a token to a Raycast or Cursor extension	Pairing
Navigate to a tab the user already has open	MCP list_recent_tabs + focus_query_tab
Insert rows from iPhone or iPad	iOS Shortcuts

URL scheme drives the GUI. MCP exchanges data. Pairing bootstraps trust.

Security model

Every request must clear three independent gates: the connection’s external access level (blocked, readOnly by default, or readWrite), the token’s scope, and the connection’s AI policy plus Safe Mode. The effective permission is the lower of token scope and connection access. See Tokens for the full model.

Every request is recorded in the activity log. Open Settings > Integrations and click View Activity to inspect.

Quick start

• Install the Raycast extension and run Pair with TablePro.
• Or wire stdio MCP into your MCP client without an extension.
• Or open a deep link from your shell:

open "tablepro://connect/9f1f0c3e-2e3d-4b14-9c3a-1d2f4ad1f6f1"

Versioning

The External API follows TablePro’s semver. Paths and tools are additive within a major version. See Versioning for the deprecation policy.

Subpages

• URL Scheme: every tablepro:// action and parameter.
• Terminal and DDEV: open databases and files from the shell, ddev tablepro, trusted links.
• iOS Shortcuts: App Intents for adding rows and opening connections.
• MCP Tools: JSON-RPC tool catalog with input and output schemas.
• MCP Resources: resources you can read.
• Pairing: sequence diagram and PKCE flow.
• Tokens: scope model, allowlists, revocation.
• Raycast: extension install and command list.
• MCP Clients: stdio MCP setup for Claude Desktop, Claude Code, Cursor, Cline, Continue, Zed, Windsurf, Goose, and custom clients.
• Versioning: stability policy.