Documentation Index

Fetch the complete documentation index at: https://docs.crewform.tech/llms.txt

Use this file to discover all available pages before exploring further.

​

Agents Guide

​

Creating an Agent

​

Required Fields

​

Optional Fields

​

Supported Models

​

Anthropic (Claude)

​

Google (Gemini)

​

OpenAI (GPT)

​

Writing System Prompts

​

Be Specific

❌ "You are a helpful assistant."
✅ "You are a senior code reviewer specializing in TypeScript and React.
    You review code for bugs, performance issues, and best practices.
    Output your review as a numbered list with severity (HIGH/MEDIUM/LOW)."

​

Define Output Format

You must respond in the following JSON format:
{
  "summary": "one-line summary",
  "findings": [{ "severity": "HIGH|MEDIUM|LOW", "description": "..." }],
  "recommendation": "overall recommendation"
}

​

Set Boundaries

You ONLY review code. If asked to write new code, respond with:
"I'm configured as a reviewer. Please create a separate coding agent."

​

Agent Lifecycle

Created → Idle → Running (task assigned) → Idle
                    ↓
               Failed (error)

• Idle: Ready to accept tasks
• Running: Actively processing a task
• Failed: Task errored — check the task detail for the error message

​

Output Routes

1. Open the agent in Agents → [Agent Name] → Settings
2. Scroll to Output Routes
3. Select one or more channels from the dropdown — or leave blank to send to all

Leave blank (default) = broadcast to all active routes. Select specific channels to narrow delivery.

​

How it works

​

Voice Profiles

​

Configuring a Voice Profile

1. Open an agent → click the Voice Profile tab
2. Select a Tone Preset — Formal, Casual, Technical, Creative, Empathetic, or Custom
3. Add Custom Voice Instructions — e.g. “Always refer to customers as ‘members’. Use active voice. Avoid jargon.”
4. Add Output Format Hints (optional) — e.g. “Use numbered lists for steps. Keep responses under 200 words.”
5. Click Save Voice Profile

​

Tone Presets

​

Brand Voice Templates

1. Configure the tone, instructions, and format hints
2. Click Save as Template → give it a name (e.g. “Acme Brand Voice”)
3. On any other agent, select the template from the Brand Voice Template dropdown

​

How It Works at Runtime

[Agent's base system prompt]

## Voice & Tone
Tone: formal
Always refer to customers as 'members'. Use active voice. Avoid jargon.
Output format: Use numbered lists for steps. Keep responses under 200 words.

[Task instructions]

​

Output Templates

​

Configuring an Output Template

1. Open an agent → click the Output Template tab
2. Select a Template Type — Markdown, JSON, HTML, CSV, or Custom
3. Write the Template Body using {{variable}} syntax:

# {{task_title}}

> Generated by **{{agent_name}}** on {{timestamp}}

{{task_result}}

---
*Tokens used: {{tokens_used}} · Model: {{model}}*

4. Click Preview to see it rendered with sample data
5. Click Save Template

​

Available Variables

​

How It Works at Runtime

LLM raw output → {{task_result}} slot in template → Final formatted result

​

MCP Server Publishing

​

Publishing an Agent

1. Open the agent in Agents → [Agent Name]
2. Click the MCP Publish button in the header bar
3. The button changes to MCP Published (green) — the agent is now exposed as an MCP tool

​

What Happens

​

Connecting External Clients

1. Go to Settings → MCP Servers
2. Click Generate MCP API Key to create a cf_mcp_ prefixed key
3. Copy the auto-generated config snippet into your client:

{
  "mcpServers": {
    "crewform": {
      "url": "https://runner.crewform.tech/mcp",
      "headers": {
        "Authorization": "Bearer cf_mcp_your_key_here"
      }
    }
  }
}

​

Export & Import

​

Exporting an Agent

1. Open the agent in Agents → [Agent Name]
2. Click the Export button in the header bar
3. A crewform-agent-{name}.json file downloads automatically

​

Importing an Agent

1. Navigate to Agents list page
2. Click the Import button in the top-right
3. Select a .json file (CrewForm export format)
4. The agent is created with an (imported) suffix

​

Export Format

{
  "format": "crewform-export",
  "version": 1,
  "type": "agent",
  "exported_at": "2026-04-08T12:00:00.000Z",
  "data": {
    "name": "Code Reviewer",
    "model": "claude-sonnet-4-20250514",
    "system_prompt": "You are an expert code reviewer...",
    "tools": ["web_search", "knowledge_search"],
    ...
  }
}

​

Using Agents in Teams

​

API Key Security

• Encrypted client-side before being sent to the database
• Never stored in plaintext
• Only decrypted by the task runner at execution time
• Scoped to your workspace via Row-Level Security