Cursor rule

1---
2description: "Lightweight index for Compozy configuration examples and patterns - references focused files for specific configuration types"
3globs:
4  - "**/compozy.yaml"
5  - "**/workflow.yaml"
6  - "**/workflows/*.yaml"
7  - "**/agents/*.yaml"
8  - "**/tools/*.yaml"
9  - "**/*.compozy.yaml"
10alwaysApply: false
11---
12# Compozy Configuration Examples Index
13 
14<configuration_overview type="yaml_patterns">
15Compozy uses YAML configuration files to define projects, workflows, agents, tools, and runtime settings. This index references focused documentation for each configuration type.
16</configuration_overview>
17 
18## Configuration File Types
19 
20### Project Configuration (`compozy.yaml`)
21See [compozy-project-config.mdc](mdc:.cursor/rules/compozy-project-config.mdc) for:
22- Basic project configuration
23- Model configuration patterns
24- AutoLoad configuration
25- Runtime permissions
26- Environment variable patterns
27 
28### Workflow and Task Configuration
29See [compozy-task-patterns.mdc](mdc:.cursor/rules/compozy-task-patterns.mdc) for:
30- All task type patterns (basic, composite, parallel, collection, router, signal, aggregate)
31- Workflow configuration structure
32- Tool configuration
33- Execution strategies
34- Trigger patterns
35- Deno configuration
36 
37### Agent Configuration
38See [compozy-agent-config.mdc](mdc:.cursor/rules/compozy-agent-config.mdc) for:
39- Basic agent configuration
40- Agent instructions and actions
41- Agent with MCP integration
42- Tool integration patterns
43 
44### Shared Patterns
45See [compozy-shared-patterns.mdc](mdc:.cursor/rules/compozy-shared-patterns.mdc) for:
46- MCP integration patterns (filesystem, HTTP)
47- Reference patterns (local, global, resource)
48- Template expression patterns
49- Use patterns for tools and agents
50 
51## Quick Reference
52 
53```yaml
54# Basic project structure
55name: project-name
56version: 0.1.0
57workflows:
58  - source: ./workflow.yaml
59 
60# Basic task structure
61- id: task_name
62  type: basic
63  $use: tool(local::tools.#(id=="tool_name"))
64  with:
65    param: "{{ .workflow.input.value }}"
66 
67# Basic agent structure
68resource: agent
69id: agent_name
70config:
71  provider: groq
72  model: llama-3.3-70b-versatile
73```
74