Quickstart for Developers

This guide helps developers integrate Sire into applications, build custom MCP servers, and use the API for programmatic workflow management.

Step 1: Get Your API Key

1. Sign up at sire.run.
2. Go to Settings > API Keys.
3. Click Create API Key and copy it immediately (it is shown only once).
4. Store the key in your application's secret manager or environment variables.

export SIRE_API_KEY="your-api-key-here"

Step 2: Trigger a Workflow via API

Use the REST API to create and run workflows programmatically.

Create and Deploy a Workflow

curl -X POST https://sire.run/api/v1/workflows \
  -H "Authorization: Bearer $SIRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Data Sync",
    "prompt": "Fetch new records from the sales API and insert them into the analytics database"
  }'

Execute a Workflow

curl -X POST https://sire.run/api/v1/workflows/{workflow_id}/execute \
  -H "Authorization: Bearer $SIRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "date_range": "last_24_hours"
    }
  }'

Check Execution Status

curl https://sire.run/api/v1/executions/{execution_id} \
  -H "Authorization: Bearer $SIRE_API_KEY"

Step 3: Build a Custom MCP Server

MCP servers let you expose any tool or service to Sire. A custom MCP server is a lightweight HTTP service that implements the JSON-RPC 2.0 protocol.

Using Mint (Recommended)

Sire's open-source CLI tool Mint generates MCP servers from OpenAPI specs.

# Install Mint
go install github.com/sirerun/mint@latest

# Generate an MCP server from an OpenAPI spec
mint mcp generate --spec openapi.yaml --output ./my-mcp-server

# Validate the generated server
mint validate ./my-mcp-server

# Build and run
cd my-mcp-server
go build -o server .
./server --port 3000

Manual Implementation

If your tool does not have an OpenAPI spec, implement the MCP protocol directly.

Your server must handle these JSON-RPC methods:

• tools/list -- returns the list of tools your server provides.
• tools/call -- executes a specific tool with the given parameters.

Register Your Server

Once running, register it in Sire:

1. Go to Settings > MCP Servers.
2. Click Register Server.
3. Enter the server name and URL (e.g., https://my-mcp-server.example.com/rpc).

Your custom tools are now available in all workflows.

Step 4: Use the Embeddable Chat SDK

Add Sire's conversational interface to your own application using the @sire/chat SDK.

import { SireChat } from '@sire/chat';

const chat = new SireChat({
  apiKey: process.env.SIRE_API_KEY,
  tenantId: 'your-tenant-id',
});

// Send a message and get a streaming response
const stream = chat.send('Run the weekly sales report');
for await (const chunk of stream) {
  console.log(chunk.text);
}

The SDK supports streaming responses, workflow execution from chat, and human-in-the-loop approval flows.

Step 5: Integrate with CI/CD

Trigger Sire workflows from your CI/CD pipeline for tasks like deployment verification, data migrations, or post-deploy testing.

# GitHub Actions example
- name: Run post-deploy verification
  run: |
    curl -X POST https://sire.run/api/v1/workflows/$WORKFLOW_ID/execute \
      -H "Authorization: Bearer ${{ secrets.SIRE_API_KEY }}" \
      -d '{"inputs": {"environment": "production", "commit_sha": "${{ github.sha }}"}}'

Step 6: Use the Sire MCP Server in Claude Code

If you use Claude Code, connect it to Sire's own MCP server for agentic workflow management.

Add to your .mcp.json:

{
  "mcpServers": {
    "sire": {
      "url": "https://sire.mcp.sire.run/rpc",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

This gives Claude Code access to tools like list_workflows, execute_workflow, search_executions, and more. See the Sire MCP Server docs for the full tool list.

Next Steps

• Read the API Reference for the complete endpoint catalog.
• Explore MCP Integration for advanced tool connectivity patterns.
• Browse the Use Case Gallery for automation ideas to build into your applications.