Getting Started

Learn how to integrate AI tools with your Bizily business data using the MCP API.

What is MCP?

The Model Context Protocol (MCP) is a standardized way for AI assistants to access external data and tools. Bizily's MCP server allows AI tools like Claude Desktop, ChatGPT, and Cursor to:

  • Search and view your customer database
  • Check upcoming bookings and availability
  • Create new appointments
  • Send messages to customers
  • Query your business knowledge base

Step 1: Get Your API Key

Navigate to your business settings and open the Developer tab. You'll find your API key there, which you can copy to use in your requests.

Security tip: Keep your API key secret. Never share it publicly or commit it to version control. If compromised, regenerate it immediately from the Developer settings.

Go to Settings → Developer

Step 2: Make Your First Request

Use the discovery endpoint to see what resources and tools are available:

Discovery requestbash
curl https://app.bizily.io/api/mcp \
  -H "Authorization: Bearer YOUR_API_KEY"

This returns a JSON schema describing all available resources and tools based on your API key's scopes.

Step 3: Query a Resource

Let's search for your recent customers:

Search customersbash
curl -X POST https://app.bizily.io/api/mcp \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "resource",
    "name": "customers",
    "params": {
      "limit": 5,
      "sortBy": "lastInteractionAt"
    }
  }'

Step 4: Use a Tool

Tools perform actions. Here's how to add a note to a customer:

Add customer notebash
curl -X POST https://app.bizily.io/api/mcp \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "tool",
    "name": "add_customer_note",
    "params": {
      "customerId": "CUSTOMER_UUID",
      "note": "Prefers morning appointments",
      "category": "preference"
    }
  }'

Next Steps