Skip to content

base/base-builder-mcp

Repository files navigation

Base Builder MCP - Alpha Release

This repository is an MCP server destined for Base Builders.

In this alpha release, the server contains an implementation of Base Docs adapted for Model Context Protocol (MCP).

Follow the instructions below to use it 👇

Build the server

First, let's build the server:

  • Clone the repo and navigate to the directory:
git clone https://github.com/youssefea/base-builder-mcp
cd base-builder-mcp
  • (Optional) Add an OpenAI key to your environment variables
echo "OPENAI_API_KEY=your_api_key_here" >> .env
  • Install the dependencies and build the server:
npm install
npx tsc

Add to Cursor agent

Build and Configure

To add this MCP to your Cursor agent, make sure your server is built then add the following config to your project as shown in the cursor documentation:

{
    "mcpServers": {
      "base-builder-mcp": {
        "command": "node",
        "args": ["/PATH_WHERE_REPO_IS_CLONED/base-builder-mcp/build/index.js"],
        "env": {
          "OPENAI_API_KEY": "" //OPENAI KEY IS OPTIONAL BUT RECOMENDED
        },
        "disabled": false,
        "autoApprove": []
      }
    }
  }

⚠️ MAKE SURE TO UPDATE PATH_WHERE_REPO_IS_CLONED ABOVE TO THE CORRECT PATH OF YOUR CLONED REPO DIRECTORY ⚠️

To add the MCP server to your project configuration, you need to create a json file at .cursor/mcp.json.

To add the MCP server to your global configuration, you need to create a json file at \~/.cursor/mcp.json.

✅ OPENAI Key is optional but recommended. It allows the guide to be reviewed and digested by another LLM to create a json file of the guide instead of feeding raw guide text to your agent.

Add to Cursor Rules

Add the following to your Cursor rules by going to the command palette (Cmd/Ctrl + Shift + P) and selecting > Cursor Settings > Rules:

<MCP_USE_GUIDELINE>
  <INSTRUCTION>
    If the user says "I want to build on Base", make frequent use of the BuildOnBase MCP tool from Base-Docs MCP.
  </INSTRUCTION>
  <TOOLS>
    What is the BuildOnBase tool from Base Builder MCP?
    It's a tool which allows you to browse the sidebar of Base Docs and find the relevant guides to Build on Base. If you run this tool and you get an error because the guide is not found, try other guides from the sidebar.
  </TOOLS>
</MCP_USE_GUIDELINE>

Add to Claude Desktop

If you want to use Base Docs MCP on your Claude Desktop App, make sure your server is built, then you can add the following config to filesystem as detailed in the Claude MCP documentation:

{
    "mcpServers": {
      "base-builder-mcp": {
        "command": "node",
        "args": ["/PATH_WHERE_REPO_IS_CLONED/base-builder-mcp/build/index.js"],
        "env": {
          "OPENAI_API_KEY": "" //OPENAI KEY IS OPTIONAL BUT RECOMENDED
        },
        "disabled": false,
        "autoApprove": []
      }
    }
  }

This config should be added to the following paths:

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

✅ OPENAI Key is optional but recommended. It allows the guide to be reviewed and digested by another LLM to create a json file of the guide instead of feeding raw guide text to your agent.

Expected Result

After adding Base Builder MCP to your agent, you can use it by saying "I want to build with base". Using that should trigger a call to the Base Builder MCP server:

Cursor Agent Cursor agent calling Base Builder MCP

Claude Agent Claude agent calling Base Builder MCP

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published