Claude Code Integration

apx integrates with Claude Code in two ways:

Plugin (recommended) — full experience with MCP tools, hooks, and skills
Skill — lightweight, knowledge-only (no MCP tools)

Plugin Installation

The plugin provides MCP tools for dev server management, component search, SDK docs, and more.

Prerequisites

Install the apx CLI first:

curl -fsSL https://databricks-solutions.github.io/apx/install.sh | sh

Install from Marketplace

/plugin marketplace add databricks-solutions/apx
/plugin install apx@databricks-solutions-apx

What's Included

Component	Description
MCP Server	15 tools for dev servers, components, docs, routes, feedback
Skills	Quick reference + detailed backend/frontend patterns
Hooks	SessionStart check for apx CLI availability

MCP Tools

The plugin registers the apx mcp server, which provides these tools:

Tool	Description
`start`	Start the development server and return its URL. Call before testing UI or API changes.
`stop`	Stop the development server.
`restart`	Restart the development server (preserves port). Use after backend code changes.
`logs`	Fetch recent dev server logs. Use to diagnose runtime errors or startup issues.
`check`	Run TypeScript and Python type checks in parallel. Returns categorized errors. Call after making changes to verify correctness.
`routes`	List all API routes with their parameters, request/response schemas, and generated hook names. Call this first to understand the project's API surface before reading source files.
`get_route_info`	Get a complete frontend code example for a specific API route, including Suspense/ErrorBoundary scaffold and correct hook usage with parameters. Call this before writing any frontend code that uses an API route. Pass the operation_id from the routes tool.
`refresh_openapi`	Regenerate the OpenAPI schema and TypeScript API client from backend routes. Run after adding or modifying backend routes.
`search_registry_components`	Semantic search for UI components across configured registries (shadcn, etc). Returns component IDs usable with add_component.
`add_component`	Install a UI component into the project. Accepts 'component-name' (default registry) or '@registry-name/component-name'.
`list_registry_components`	List all available components in a registry. Defaults to shadcn registry if none specified.
`docs`	Search Databricks SDK documentation for Python code examples and API references. Always call this before writing any Databricks SDK (ws.*) call to verify the correct method signature.
`databricks_apps_logs`	Fetch logs from a deployed Databricks App using the Databricks CLI. Use for debugging deployed (not local dev) issues.
`feedback_prepare`	Prepare a feedback issue for review. Returns formatted title, body, and browser URL.
`feedback_submit`	Submit a prepared feedback issue as a public GitHub issue (requires `gh` CLI).

Automatic Installation via `apx init`

When you initialize a project with any assistant addon, skill files are installed automatically:

# Claude addon: skills → .claude/skills/apx/
apx init --addons=ui,claude

# Cursor addon: skills → .claude/skills/apx/
apx init --addons=ui,cursor

# Codex addon: skills → .agents/skills/apx/
apx init --addons=ui,codex

Each assistant addon installs skill markdown files, .mcp.json, and hooks/hooks.json alongside its own configuration files (e.g., CLAUDE.md, .cursor/rules/, AGENTS.md).

Skill Installation (Standalone)

If you only need the knowledge reference without MCP tools, install the standalone skill:

Using the CLI (recommended if apx is installed)

apx skill install

For global installation (all projects):

apx skill install --global

To install to a custom path (e.g., for Codex):

apx skill install --path .agents/skills/apx

Options

Option	Description
`--global`	Install to home directory (`~/`) instead of current directory
`--path`	Skill files directory (default: `.claude/skills/apx`)

Using the install script

Project-Level (Current Project)

curl -fsSL https://databricks-solutions.github.io/apx/install.sh --skill | sh

This installs skill files to .claude/skills/apx/ in the current directory.

Global (All Projects)

curl -fsSL https://databricks-solutions.github.io/apx/install.sh | sh -s -- --skill --global

This installs skill files to ~/.claude/skills/apx/.

Skill Files

The skill install command copies these files plus .mcp.json and hooks/hooks.json:

File	Content
`SKILL.md`	Quick reference: commands, MCP tools, workflow, do's and don'ts
`backend-patterns.md`	DI, 3-model pattern, CRUD routers, lifespan, AppConfig
`frontend-patterns.md`	Suspense, mutations, selector, component conventions

Project-Level Integration

For project-specific integration with MCP config and skill files:

apx dev apply claude

This installs skill files, .mcp.json, and hooks using your project's configuration. See the CLI reference for details.

Claude Code Integration

On this page