Integrations Overview
Connect faz to Claude Desktop, Cursor, Claude Code, OpenClaw, any MCP-compatible client, or use the REST API directly.
faz is a server. Once installed, it can be reached two ways: over MCP (the protocol AI assistants use to call tools) and over HTTP (the REST API). The pages in this section cover wiring up each of the supported MCP clients, plus the REST surface for everything else.
What's MCP, briefly
The Model Context Protocol is a standard for AI clients to talk to external tools. An MCP server exposes a set of named tools; the AI client lists them, calls them with structured arguments, and gets back structured responses. faz exposes four tools over MCP and runs the safety pipeline on every call.
Once you've wired faz into your MCP client, your AI assistant can ask for the list of databases, inspect schemas, and run queries — without you writing any glue code.
Pick your client
Claude Desktop
Anthropic's desktop chat app. faz mcp install --target claude wires it up.
Claude Code
Anthropic's terminal CLI. Same MCP support, slightly different config path.
Cursor
The editor-with-AI. User-level config plus per-workspace overrides.
OpenClaw
OpenClaw uses a nested config shape. faz writes it directly or via the openclaw mcp set CLI.
Generic MCP
Any other MCP-compatible client — Continue, Zed, your own. Generate the JSON, drop it in.
REST API
Non-MCP clients, scripts, CI. Same pipeline, plain HTTP.
What faz mcp install writes
faz mcp install is the bundled installer. It writes the MCP server entry — the JSON object that tells a client how to spawn faz mcp — to the right config file for each client. The entry is identical across clients:
{
"command": "/absolute/path/to/faz",
"args": ["mcp"],
"env": {
"FAZ_CONFIG": "/absolute/path/to/faz.yaml"
}
}What changes between clients is where this object goes:
| Client | Config path | JSON nesting |
|---|---|---|
| Claude Desktop | ~/Library/Application Support/Claude/claude_desktop_config.json (macOS), ~/.config/Claude/claude_desktop_config.json (Linux), %APPDATA%\Claude\claude_desktop_config.json (Windows) | mcpServers.faz |
| Cursor | ~/.cursor/mcp.json | mcpServers.faz |
| OpenClaw | ~/.openclaw/openclaw.json | mcp.servers.faz |
The --target flag picks one or more:
faz mcp install # auto-detect and write all three
faz mcp install --target claude # only Claude Desktop
faz mcp install --target claude-code
faz mcp install --target cursor
faz mcp install --target openclaw
faz mcp install --target claude --dry-run # preview the JSON, don't write--path overrides the auto-detected location, useful for previewing or for clients we don't know about — see Generic MCP.
What if I don't use MCP?
Use the REST API. faz serve exposes the same four capabilities over HTTP at 127.0.0.1:8787. The contract is identical, the audit log is the same, and you can put faz behind a reverse proxy with your own auth for remote access. See REST API.
After installing — verify
Whichever client you pick, the verification flow is the same:
- Restart the client fully. MCP clients only re-read their config on startup.
- Ask the assistant something faz would answer: "What databases do you have access to?" or "Describe the columns of table X."
- If you don't get an answer, see Verifying the connection for the diagnostic steps. If the client doesn't see faz at all, see MCP not loading.
Related
- MCP tools — the four tools every MCP client gets.
- REST endpoints — the same surface over HTTP.
- Verifying the connection — confirm the wire-up.
- MCP not loading — fixes when the client doesn't see faz.