For the complete documentation index, see llms.txt. This page is also available as Markdown.

Client Configuration

Configure VS Code, Claude Desktop, Cursor, and other MCP clients to connect to your BoxLang MCP server.

This guide covers how to configure different MCP clients to connect to the BoxLang MCP server.


๐Ÿ”Œ Connection Basics

The BoxLang MCP server is available at:

http://localhost:8080/~bxmcp/boxlang.bxm

All clients use the same JSON-RPC 2.0 endpoint. The only differences are where and how you store the configuration.

Common Configuration Shape

{
  "mcpServers": {
    "boxlang": {
      "url": "http://localhost:8080/~bxmcp/boxlang.bxm",
      "headers": {
        "Authorization": "Bearer your-auth-token"
      }
    }
  }
}

Replace your-auth-token with the value of authToken from your module settings. If authToken is empty, omit the headers block.


๐Ÿ†š VS Code

Create a .vscode/mcp.json file in your project root:

VS Code automatically detects and connects to MCP servers defined in .vscode/mcp.json when you open the workspace. The MCP tools become available to GitHub Copilot and other AI features.


๐Ÿค– Claude Desktop

Add the server configuration to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

Restart Claude Desktop after adding the configuration.


๐Ÿ–ฅ๏ธ Cursor

Create a .cursor/mcp.json file in your project root:

Cursor will automatically connect to the MCP server and make the tools available for AI-powered development.


๐Ÿš Generic HTTP Client (curl)

List All Tools

Call a Tool

List All Prompts

Get a Specific Prompt


๐Ÿ“ Tool Filtering at the Client Level

Some MCP clients support restricting which tools are visible. This is a client-side setting and does not replace server-side authorization. For true access control, use the server-side authToken array-of-structs approach described in Security & Access Control.


๐ŸŒ Remote Connections

To connect to a remote BoxLang server (not localhost):

  1. Update allowedIPs in your module configuration to include your client's IP or CIDR range

  2. Set a strong authToken โ€” never expose a remote endpoint without authentication

  3. Enable HTTPS on your web server for encrypted transport

  4. Update the URL in your client configuration to point to the remote host


๐ŸŽฎ Interactive CLI

The module ships with a built-in interactive CLI client. See the README for usage instructions.


๐Ÿ“š Next Steps

Last updated

Was this helpful?