MCP Tools Reference

InsForge provides MCP (Model Context Protocol) tools for AI agents to manage backend infrastructure, deploy applications, and fetch documentation. These tools enable AI coding assistants to work directly with your InsForge backend.

MCP tools are for infrastructure management (creating tables, deploying functions, managing buckets). Use the SDK for application logic (auth, database queries, file uploads).

Installation

The InsForge MCP server is automatically available when you run InsForge locally:

docker compose up

Access the dashboard at http://localhost:7130 and follow the connection instructions for your AI agent.

Documentation Tools

fetch-docs

Fetch specific SDK documentation for building applications. Parameters:

type (required) - Documentation type to fetch

Available types:

"instructions" - Essential backend setup (START HERE)
"db-sdk-typescript" - Database operations with TypeScript SDK
"auth-sdk-typescript" - TypeScript SDK auth methods
"auth-components-react" - Pre-built React auth UI (Vite)
"auth-components-react-router" - Pre-built React auth UI (React Router)
"auth-components-nextjs" - Pre-built Next.js auth UI
"storage-sdk" - File storage operations
"functions-sdk" - Serverless functions invocation
"ai-integration-sdk" - AI chat and image generation
"real-time" - Real-time pub/sub via WebSockets
"deployment" - Deploy frontend applications

Example:

// Agent call
fetch_docs({ type: "auth-sdk-typescript" })

Returns: Detailed SDK documentation with code examples and API reference.

fetch-sdk-docs

Fetch SDK documentation for specific features and languages. Parameters:

feature (required) - Feature type: "db", "storage", "functions", "auth", "ai", "realtime"
language (required) - SDK language: "typescript", "swift", "kotlin", "rest-api"

Example:

// Get Swift SDK auth documentation
fetch_sdk_docs({ 
  feature: "auth", 
  language: "swift" 
})

// Get Kotlin database documentation
fetch_sdk_docs({ 
  feature: "db", 
  language: "kotlin" 
})

Returns: Language-specific SDK documentation with examples.

Backend Management

get-backend-metadata

Retrieve backend configuration and connection details. Parameters: None Example:

get_backend_metadata()

Returns:

{
  "baseUrl": "https://your-app.region.insforge.app",
  "anonKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "region": "us-west-1",
  "version": "2.0.1",
  "features": {
    "auth": true,
    "storage": true,
    "functions": true,
    "ai": true,
    "realtime": true
  }
}

Database Tools

run-raw-sql

Execute raw SQL queries on your PostgreSQL database. Parameters:

sql (required) - SQL query to execute
params (optional) - Parameterized query values

Example:

// Create a table
run_raw_sql({
  sql: `
    CREATE TABLE posts (
      id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
      title TEXT NOT NULL,
      content TEXT,
      user_id UUID REFERENCES users(id) ON DELETE CASCADE,
      created_at TIMESTAMPTZ DEFAULT NOW()
    )
  `
})

// Create an index
run_raw_sql({
  sql: "CREATE INDEX idx_posts_user_id ON posts(user_id)"
})

// Parameterized query
run_raw_sql({
  sql: "SELECT * FROM posts WHERE user_id = $1",
  params: ["user-123"]
})

Use with caution. Raw SQL bypasses Row Level Security (RLS) policies. Prefer using the SDK for application queries.

get-table-schema

Retrieve the schema definition for a database table. Parameters:

tableName (required) - Name of the table

Example:

get_table_schema({ tableName: "posts" })

Returns:

{
  "tableName": "posts",
  "columns": [
    {
      "name": "id",
      "type": "uuid",
      "nullable": false,
      "default": "gen_random_uuid()"
    },
    {
      "name": "title",
      "type": "text",
      "nullable": false
    },
    {
      "name": "content",
      "type": "text",
      "nullable": true
    },
    {
      "name": "created_at",
      "type": "timestamptz",
      "nullable": false,
      "default": "NOW()"
    }
  ],
  "primaryKey": ["id"],
  "foreignKeys": [
    {
      "column": "user_id",
      "references": "users(id)",
      "onDelete": "CASCADE"
    }
  ],
  "indexes": [
    {
      "name": "idx_posts_user_id",
      "columns": ["user_id"]
    }
  ]
}

Storage Tools

create-bucket

Create a new storage bucket for file uploads. Parameters:

name (required) - Bucket name (lowercase, alphanumeric, hyphens)
public (optional) - Whether bucket is publicly accessible (default: false)

Example:

// Create public bucket for user avatars
create_bucket({ 
  name: "avatars", 
  public: true 
})

// Create private bucket for documents
create_bucket({ 
  name: "documents", 
  public: false 
})

Returns:

{
  "name": "avatars",
  "public": true,
  "createdAt": "2024-01-15T10:00:00Z"
}

list-buckets

List all storage buckets in your backend. Parameters: None Example:

list_buckets()

Returns:

[
  {
    "name": "avatars",
    "public": true,
    "createdAt": "2024-01-15T10:00:00Z"
  },
  {
    "name": "documents",
    "public": false,
    "createdAt": "2024-01-16T09:30:00Z"
  }
]

delete-bucket

Delete a storage bucket and all its contents. Parameters:

name (required) - Bucket name to delete

Example:

delete_bucket({ name: "old-bucket" })

This permanently deletes all files in the bucket. This action cannot be undone.

Functions Tools

create-function

Deploy a new serverless edge function. Parameters:

slug (required) - Function name/slug (URL-safe)
code (required) - Function code (TypeScript/JavaScript)
description (optional) - Function description

Example:

create_function({
  slug: "hello-world",
  description: "A simple greeting function",
  code: `
    export default async function(req: Request): Promise<Response> {
      const { name } = await req.json();
      
      return new Response(
        JSON.stringify({ 
          message: \`Hello, \${name || 'World'}!\`,
          timestamp: new Date().toISOString()
        }),
        {
          status: 200,
          headers: { 'Content-Type': 'application/json' }
        }
      );
    }
  `
})

Returns:

{
  "slug": "hello-world",
  "url": "https://your-app.region.insforge.app/api/functions/hello-world",
  "createdAt": "2024-01-15T10:00:00Z"
}

update-function

Update an existing serverless function. Parameters:

slug (required) - Function slug to update
code (required) - New function code
description (optional) - Updated description

Example:

update_function({
  slug: "hello-world",
  code: `
    export default async function(req: Request): Promise<Response> {
      const { name } = await req.json();
      
      // Updated with greeting customization
      const greeting = req.headers.get('X-Greeting') || 'Hello';
      
      return new Response(
        JSON.stringify({ 
          message: \`\${greeting}, \${name || 'World'}!\`
        }),
        { status: 200, headers: { 'Content-Type': 'application/json' } }
      );
    }
  `
})

delete-function

Delete a serverless function. Parameters:

slug (required) - Function slug to delete

Example:

delete_function({ slug: "old-function" })

list-functions

List all deployed serverless functions. Parameters: None Example:

list_functions()

Returns:

[
  {
    "slug": "hello-world",
    "description": "A simple greeting function",
    "url": "https://your-app.region.insforge.app/api/functions/hello-world",
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-15T11:00:00Z"
  }
]

Deployment Tools

download-template

Download a starter template pre-configured with your InsForge backend. Parameters:

template (required) - Template name: "react-vite", "nextjs", "vue", "svelte"
outputPath (required) - Local directory path for the template

Example:

download_template({
  template: "react-vite",
  outputPath: "./my-app"
})

Returns:

{
  "template": "react-vite",
  "path": "./my-app",
  "configured": true,
  "nextSteps": [
    "cd my-app",
    "npm install",
    "npm run dev"
  ]
}

create-deployment

Deploy a frontend application to InsForge hosting. Parameters:

buildDirectory (required) - Path to build output directory
projectName (optional) - Custom project name

Example:

// After building your app
create_deployment({
  buildDirectory: "./dist",
  projectName: "my-app"
})

Returns:

{
  "deploymentId": "dep_abc123",
  "url": "https://my-app.insforge.app",
  "status": "deployed",
  "createdAt": "2024-01-15T10:00:00Z"
}

Usage Best Practices

When to Use MCP Tools

✅ Use MCP tools for:

Creating database tables and schemas
Managing storage buckets
Deploying serverless functions
Fetching documentation for AI agents
Infrastructure setup and configuration

❌ Don’t use MCP tools for:

Application authentication (use SDK auth methods)
Database queries in your app (use SDK database methods)
File uploads from users (use SDK storage methods)
Real-time messaging (use SDK realtime methods)

Example Workflow

// 1. Agent creates infrastructure with MCP tools
run_raw_sql({
  sql: `
    CREATE TABLE posts (
      id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
      title TEXT NOT NULL,
      content TEXT,
      user_id UUID REFERENCES users(id),
      created_at TIMESTAMPTZ DEFAULT NOW()
    )
  `
})

create_bucket({ name: "post-images", public: true })

// 2. Agent fetches SDK docs
fetch_docs({ type: "db-sdk-typescript" })

// 3. Agent writes application code using SDK
// (This is JavaScript/TypeScript code, not MCP tool calls)
import { insforge } from './lib/insforge';

const { data: posts } = await insforge.database
  .from('posts')
  .select('*');

Resources

TypeScript SDK

Use SDK for application logic

Database Guide

Learn about database operations

Functions Guide

Deploy serverless functions

Storage Guide

Manage file storage

Get Started

Core Features

SDKs & Integration

Platform

Resources

MCP Tools Reference

Installation

Documentation Tools

fetch-docs

fetch-sdk-docs

Backend Management

get-backend-metadata

Database Tools

run-raw-sql

get-table-schema

Storage Tools

create-bucket

list-buckets

delete-bucket

Functions Tools

create-function

update-function

delete-function

list-functions

Deployment Tools

download-template

create-deployment

Usage Best Practices

When to Use MCP Tools

Example Workflow

Resources

TypeScript SDK

Database Guide

Functions Guide

Storage Guide

Get Started

Core Features

SDKs & Integration

Platform

Resources

Documentation Index

​Installation

​Documentation Tools

​fetch-docs

​fetch-sdk-docs

​Backend Management

​get-backend-metadata

​Database Tools

​run-raw-sql

​get-table-schema

​Storage Tools

​create-bucket

​list-buckets

​delete-bucket

​Functions Tools

​create-function

​update-function

​delete-function

​list-functions

​Deployment Tools

​download-template

​create-deployment

​Usage Best Practices

​When to Use MCP Tools

​Example Workflow

​Resources

TypeScript SDK

Database Guide

Functions Guide

Storage Guide

Installation

Documentation Tools

fetch-docs

fetch-sdk-docs

Backend Management

get-backend-metadata

Database Tools

run-raw-sql

get-table-schema

Storage Tools

create-bucket

list-buckets

delete-bucket

Functions Tools

create-function

update-function

delete-function

list-functions

Deployment Tools

download-template

create-deployment

Usage Best Practices

When to Use MCP Tools

Example Workflow

Resources