Supabase MCP

🚀 Supabase MCP - Usage Guide

This guide provides a detailed introduction to installing, configuring, and using the Supabase MCP program, including database operations, file storage operations, edge function calls, user management, error handling, development, contribution guidelines, license information, and support channels.

🚀 Quick Start

📦 Installation

To install this program, execute the following command:

npm install supabase-mcp

⚙️ Configuration

Create a configuration file named supabase-mcp.config.js or .env, and add the following content:

// Or in the .env file:
# Configure the Supabase project ID
SUPABASE_PROJECT_ID=your_project_id
# Configure the Supabase anonymous key
SUPABASE_ANON_KEY=your_anon_key

💻 Usage Examples

🗄️ Database Operations

🔍 Query Data

{
  table: "users",
  columns: ["id", "email", "created_at"],
  where?: Record<string, any>
}

Example:

{
  table: "posts",
  columns: ["id", "title", "content"],
  where: { published: true }
}

📥 Insert Data

{
  table: "users",
  data: {
    email: "user@example.com",
    password: "securepassword"
  }
}

Example:

{
  table: "posts",
  data: {
    title: "Hello World",
    content: "This is my first post.",
    user_id: 1
  }
}

📝 Update Data

{
  table: "users",
  data: {
    password: "newsecurepassword"
  },
  where: { email: "user@example.com" }
}

Example:

{
  table: "posts",
  data: { status: "draft" },
  where: { id: 1 }
}

🗑️ Delete Data

{
  table: "users",
  where: { email: "user@example.com" }
}

Example:

{
  table: "posts",
  where: { status: "deleted" }
}

📂 File Storage Operations

📤 Upload File

{
  bucket: "uploads",
  path: "images/avatar.jpg",
  file: selectedFile,
  options?: {
    cacheControl?: string;
    contentType?: string;
    upsert?: boolean;
  };
}

Example:

{
  bucket: "documents",
  path: "reports/2023.pdf",
  file: fileObject,
  options: {
    contentType: "application/pdf",
    upsert: true
  }
}

📥 Download File

{
  bucket: "uploads",
  path: "images/avatar.jpg"
}

Example:

{
  bucket: "downloads",
  path: "files/report.docx"
}

🚀 Edge Function Calls

📞 Call Function

{
  function: "processData",
  params?: {
    key: string,
    value: any
  }[]
}

Example:

{
  function: "calculateTotal",
  params: [
    { key: "amount", value: 100 },
    { key: "taxRate", value: 0.15 }
  ]
}

👤 User Management

🆕 Create User

{
  email: "newuser@example.com",
  password: "securepassword"
}

Example:

{
  email: "admin@example.com",
  password: "adminsecure"
}

❌ Error Handling

The error messages returned by the program may include the following content:

• code: Error code
• message: Error description
• stack?: string: Error stack trace (if available)

Example:

{
  code: "AUTHENTICATION_FAILED",
  message: "Invalid API key provided."
}

🔧 Development

🧪 Run Tests

To run tests, execute the following command:

npm test supabase-mcp

🏗️ Build Project

To build the project, execute the following command:

npm run build

📋 Code Style Check

To perform a code style check, execute the following command:

npm run lint

🤝 Contribution Guidelines

If you wish to contribute to this project, please follow these steps:

1. Fork this repository.
2. Create a new branch for your feature: git checkout -b feature/your-feature
3. Commit your changes: git commit -m "add your feature"
4. Push to the forked repository: git push origin feature/your-feature
5. Create a pull request to the main branch.

📄 License

This project is licensed under the MIT License.

🛠️ Support

If you encounter any issues, please contact the support team via the following methods:

• Email: support@supabase-mcp.com
• Phone: +1 (555) 123-4567