Beamlit MCP server

The Beamlit MCP Server implements the Model Context Protocol standard to enable seamless interaction between the Beamlit CLI and AI models. This server acts as a communication bridge, allowing for structured data exchange between your command-line interface and various AI model services.

Prerequisites

Before installing the Beamlit MCP Server, ensure you have:

• Node.js (version 16 or higher)
• npm or yarn package manager
• Beamlit CLI installed on your system

Installation

The Beamlit MCP Server can be installed using npm:

npm install -g @beamlit/mcp-gateway

Configuration

Setting up the MCP Server

To configure the MCP server, add the following configuration to your claude_desktop_config.json file:

{
  "mcpServers": {
    "beamlit": {
      "command": "npx",
      "args": ["-y", "@beamlit/mcp-gateway"]
    }
  }
}

This configuration tells Claude Desktop to use the Beamlit MCP Gateway when communicating with AI models.

Usage

Basic Commands

To start using the Beamlit MCP Server, you can run these commands:

# Watch for changes and build MCP servers
npm run watch

# Run the MCP server
npm run start

# Run the MCP client
npm run client

Integration with Claude Desktop

To integrate with Claude Desktop:

1. Verify that Beamlit CLI is properly installed on your system
2. Ensure your MCP server is correctly configured in the Claude Desktop config file
3. Launch Claude Desktop, which will automatically connect to the Beamlit MCP Server

Troubleshooting

If you encounter issues with the Beamlit MCP Server, check these common problems:

• Connection Issues:

  • Verify that Beamlit CLI is correctly installed
  • Check that the server is running with npm run start

• Configuration Errors:

  • Double-check the syntax in your claude_desktop_config.json file
  • Ensure all paths and arguments are correctly specified

• Permission Problems:

  • Make sure you have the proper system permissions to run the server
  • Try running commands with administrator/sudo privileges if necessary

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "beamlit" '{"command":"npx","args":["-y","@beamlit/mcp-gateway"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "beamlit": {
            "command": "npx",
            "args": [
                "-y",
                "@beamlit/mcp-gateway"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

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

2. Add this to your configuration file:

{
    "mcpServers": {
        "beamlit": {
            "command": "npx",
            "args": [
                "-y",
                "@beamlit/mcp-gateway"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect