Manage bounties, assets, and payments on the Beep platform.
Beep MCP Server
This is a Model Context Protocol (MCP) server that provides tools for interacting with the Beep platform. It allows AI assistants (like Claude) to perform actions such as creating bounties, managing streams, issuing payments, and verifying transactions on the Beep network.
Features
This server exports the following MCP tools:
checkBeepApi: Verify connectivity to the Beep API.createBounty: Create a new bounty.requestAndPurchaseAsset: Request and purchase an asset.issuePayment: Issue a payment.startStreaming: Start a streaming session.stopStreaming: Stop a streaming session.pauseStreaming: Pause a streaming session.verifyTransaction: Verify a transaction.
Prerequisites
- Node.js (v18 or higher recommended)
- A Beep API Key
Installation
Clone the repository:
git clone <repository-url> cd beep-mcp-serverInstall dependencies:
npm install
Configuration
Create a
.envfile in the root directory:cp .env.example .env(Note: If
.env.exampledoesn't exist, create a.envfile manually)Add your Beep API Key and other configuration to
.env:BEEP_API_KEY=your_beep_api_key_here # Optional: Override Beep Server URL # BEEP_URL=https://api.beep.it # Communication mode (stdio is default for local MCP) COMMUNICATION_MODE=stdio
Building
Compile the TypeScript code to JavaScript:
npm run build
The build output will be in the dist/ directory.
Usage with Claude Desktop
To use this MCP server with Claude Desktop, add the following configuration to your claude_desktop_config.json (usually located at ~/Library/Application Support/Claude/claude_desktop_config.json on macOS or %APPDATA%\Claude\claude_desktop_config.json on Windows):
{
"mcpServers": {
"beep-mcp-server": {
"command": "node",
"args": [
"/absolute/path/to/beep-mcp-server/dist/mcp-server.js"
],
"env": {
"BEEP_API_KEY": "your_beep_api_key_here",
"COMMUNICATION_MODE": "stdio"
}
}
}
}
Important: Replace /absolute/path/to/beep-mcp-server with the actual full path to this directory on your machine.
Development
To run the server in stdio mode (default):
npm start
For development, you can use npm run build to rebuild after changes.
Tools (8)
checkBeepApiVerify connectivity to the Beep API.createBountyCreate a new bounty.requestAndPurchaseAssetRequest and purchase an asset.issuePaymentIssue a payment.startStreamingStart a streaming session.stopStreamingStop a streaming session.pauseStreamingPause a streaming session.verifyTransactionVerify a transaction.Environment Variables
BEEP_API_KEYrequiredYour Beep API KeyBEEP_URLOptional: Override Beep Server URLCOMMUNICATION_MODECommunication mode (stdio is default)Configuration
{
"mcpServers": {
"beep-mcp-server": {
"command": "node",
"args": [
"/absolute/path/to/beep-mcp-server/dist/mcp-server.js"
],
"env": {
"BEEP_API_KEY": "your_beep_api_key_here",
"COMMUNICATION_MODE": "stdio"
}
}
}
}