Working with AI & IDEs

Get Aexol working with your favorite AI assistant or code editor in under 5 minutes.

Quick Setup (Choose One)

Option 1: VS Code (Recommended)

Best for: Most developers, beginners

1. Install the Aexol extension from VS Code marketplace
2. Open any .aexol file
3. Get instant syntax highlighting, autocomplete, and error checking

That's it!

Option 2: Remote MCP + AI Tools

Best for: AI-powered development

1. Point your MCP client to backend endpoint https://api.aexol.ai/mcp
2. Add auth header: Authorization: Bearer sk-aexol-team-...
3. Use JSON-RPC methods: initialize, ping, tools/list, tools/call

Now ask Claude: "Validate my Aexol code" or "Generate TypeScript from this spec"

Option 3: Other IDEs (Cursor, Windsurf, Zed)

Best for: Advanced users, specific IDE preferences

Use your IDE MCP integration with backend /mcp and a team API key.

See Remote MCP Configuration.

What You Can Do

Once set up, you can:

• Ask AI to validate your Aexol code
• Generate TypeScript/Python/Rust from specs
• Get autocomplete in your editor
• See errors as you type
• Convert natural language to Aexol

MCP Scope: Backend Remote

• Remote/team MCP operations (remote_* tools): available via backend /mcp endpoint with a team API key.
• Use JSON-RPC methods: initialize, ping, tools/list, tools/call.

See Remote MCP Configuration.

Remote Tool Prerequisites

• Use backend /mcp with a team API key.
• Pass teamId and projectId where required by remote tools.

Generate Artifacts with AI Inference

Use the aexol inference command to generate production-ready artifacts:

# Generate GraphQL schema
aexol inference graphql app.aexol -o schema.graphql

# Generate Prisma database schema
aexol inference prisma app.aexol -o prisma/schema.prisma

# Generate route tree for React Router
aexol inference routes app.aexol --framework react-router

# Generate E2E test specifications
aexol inference e2e app.aexol -o tests/

See CLI Commands for the full list of inference subcommands.

Detailed Setup Guides

Remote MCP clients (OpenCode, Claude Code, Copilot CLI)

OpenCode

Use global config ~/.config/opencode/opencode.json or project-level opencode.json:

{
  "mcp": {
    "aexol": {
      "type": "remote",
      "url": "https://api.aexol.ai/mcp",
      "headers": {
        "Authorization": "Bearer sk-aexol-team-..."
      },
      "oauth": false
    }
  }
}

To call an Aexol.ai model directly from OpenCode, add a provider entry in opencode.jsonc and use your team API key:

{
  "provider": {
    "aexol.ai": {
      "name": "Aexol AI",
      "options": {
        "baseURL": "https://api.aexol.ai/v1",
        "apiKey": "sk-aexol-team-..."
      },
      "models": {
        "built-in/spectral": {
          "name": "built-in/spectral"
        }
      }
    }
  }
}

OpenCode uses the provider base URL plus the model name, so built-in/spectral resolves through Aexol.ai's built-in model route, for example /models/built-in/spectral/v1/chat/completions.

Claude Code

claude mcp add --transport http aexol https://api.aexol.ai/mcp \
  --header "Authorization: Bearer sk-aexol-team-..."

claude mcp list
claude mcp remove aexol

GitHub Copilot CLI

Configure via interactive /mcp add flow, or via ~/.copilot/mcp-config.json:

{
  "mcpServers": {
    "aexol": {
      "type": "http",
      "url": "https://api.aexol.ai/mcp",
      "headers": {
        "Authorization": "Bearer sk-aexol-team-..."
      }
    }
  }
}

See Remote MCP Configuration for protocol-level details.

Config Locations

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

Configuration

Configure Claude MCP integration to call backend /mcp and send:

Authorization: Bearer sk-aexol-team-...
Content-Type: application/json

Required JSON-RPC methods: initialize, ping, tools/list, tools/call.

Example Prompts

"Validate this Aexol code: visitor Admin { "manage users" }"
"Generate TypeScript from: type User { id: string, name: string }"
"Explain what workflow OrderProcess does"

Configure Cursor MCP integration to call backend /mcp with Bearer sk-aexol-team-....

See Remote MCP Configuration.

Configure Windsurf MCP integration to call backend /mcp with Bearer sk-aexol-team-....

See Remote MCP Configuration.

Configure Cline MCP integration to call backend /mcp with Bearer sk-aexol-team-....

Use JSON-RPC methods initialize, ping, tools/list, tools/call.

Configure Zed MCP integration to target backend /mcp with Bearer sk-aexol-team-....

See Remote MCP Configuration.

Configure Continue MCP integration to target backend /mcp with Bearer sk-aexol-team-....

See Remote MCP Configuration.

Copilot works indirectly:

1. Install Aexol VS Code extension (for context)
2. Use CLI: aexol implement app.aexol --agent copilot
3. Or generate code and let Copilot enhance it

VS Code Setup

1. Open VS Code Extensions (Cmd+Shift+X)
2. Search "Aexol"
3. Click Install

You get: Syntax highlighting, autocomplete, error checking, go-to-definition

• See errors as you type (red squiggles)
• Auto-complete types, visitors, workflows
• Hover for documentation
• Click to jump to definitions (F12)
• Find all references (Shift+F12)

Other Editors (Neovim, Emacs, Sublime)

require('lspconfig').aexol.setup{
  cmd = { "aexol", "lsp", "--stdio" },
  filetypes = { "aexol" },
}

(lsp-register-client
 (make-lsp-client :new-connection (lsp-stdio-connection '("aexol" "lsp" "--stdio"))
                  :major-modes '(aexol-mode)
                  :server-id 'aexol))

{
  "clients": {
    "aexol": {
      "enabled": true,
      "command": ["aexol", "lsp", "--stdio"],
      "selector": "source.aexol"
    }
  }
}

Troubleshooting

AI not responding?

• Verify backend /mcp is reachable
• Verify Authorization: Bearer sk-aexol-team-... is sent
• Verify path with which aexol-bin
• Restart your AI client

VS Code extension not working?

• Reload window (Cmd+Shift+P -> "Reload Window")
• Check extension is installed and enabled

Need help?

• Check aexol lsp --info command works
• See CLI Commands for more options

Next Steps

• Read the Language Reference for syntax details
• Explore Workflow Features for advanced patterns
• Check out Examples to see Aexol in action
• Join the community for tips and support

Need help? Ask your AI assistant or check the CLI Commands guide.