home / mcp / unlock mcp server

Unlock MCP Server

Provides read/write access to Unlock Protocol contracts via MCP on Base/Base-Sepolia networks.

Installation

Add the following to your MCP client configuration file.

Configuration

{
  "mcpServers": {
    "blahkheart-unlock-mcp": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/unlock-mcp/dist/index.js"
      ],
      "env": {
        "MCP_MODE": "stdio",
        "PRIVATE_KEY": "0x...",
        "LOCK_ADDRESS": "0x...",
        "INFURA_API_KEY": "abc123...",
        "UNLOCK_ADDRESS": "0x1FF7e338d5E582138C46044dc238543Ce555C963",
        "ALCHEMY_API_KEY": "xyz789..."
      }
    }
  }
}

Unlock-MCP is an MCP server that provides comprehensive access to Unlock Protocol on the Base and Base-Sepolia networks. It exposes public read and write functions from the Unlock Protocol smart contracts to enable AI agents and automated workflows to manage memberships, subscriptions, and access control.

How to use

You can run Unlock-MCP in two operating modes from the same codebase. For local development and Claude Desktop integration, use the stdio mode which runs the server as a local process. For browser-based tooling and n8n-style workflows, you can run a proxy/session with configurations that Claude Desktop can connect to via Server-Sent Events (SSE). When using stdio, the server reads and responds to requests directly in the host process. When using proxy, your client or workflow connects to the server over HTTP/SSE and can drive MCP tools from a remote client.

How to install

Prerequisites: Node.js and npm must be installed on your development machine. This guide assumes a Git repository already contains the Unlock-MCP project with an npm-based build flow.

# 1. Clone the repository
git clone <repo-url> unlock-mcp
cd unlock-mcp

# 2. Install dependencies
npm install

# 3. Copy example environment configuration
cp .env.example .env

Additional sections

Configuration and runtime options are described in the README. Key environment variables include your RPC provider keys, the Unlock contract addresses, and optional settings you may tailor for your deployment.

Security and operational notes emphasize input validation, robust error handling, health monitoring, and safe handling of keys. Use test networks for development and never commit private keys to version control.

Available tools

Read and Write Tools

A comprehensive set of 55 MCP tools covering read functions, write functions, and contract interactions to manage memberships, pricing, locks, and upgrades.