Cursor rule

1---
2description: "Project configuration patterns and examples for compozy.yaml files"
3globs:
4  - "**/compozy.yaml"
5  - "**/*.compozy.yaml"
6alwaysApply: false
7---
8# Compozy Project Configuration Examples
9 
10<configuration_overview type="project_config">
11Project configuration defines the top-level settings for Compozy projects including models, workflows, autoload settings, and runtime permissions.
12</configuration_overview>
13 
14## Basic Project Configuration
15 
16<project_config_pattern type="basic">
17```yaml
18name: project-name
19version: 0.1.0
20description: Project description
21
22workflows:
23  - source: ./workflow.yaml
24
25runtime:
26  permissions:
27    - --allow-read
28    - --allow-net
29    - --allow-env
30```
31</project_config_pattern>
32 
33## Project with Model Configuration
34 
35<project_config_pattern type="with_models">
36```yaml
37name: weather-agent
38version: "0.1.0"
39description: A multi-agent weather advisory system
40
41author:
42  name: Pedro Nauck
43  url: https://github.com/compozy
44
45workflows:
46  - source: ./workflow.yaml
47
48models:
49  - provider: groq
50    model: llama-3.3-70b-versatile
51    api_key: "{{ .env.GROQ_API_KEY }}"
52  - provider: ollama
53    model: llama4:16x17b
54    api_url: "http://localhost:11434"
55
56runtime:
57  permissions:
58    - --allow-read
59    - --allow-net
60    - --allow-env
61    - --allow-sys
62    - --allow-write
63```
64</project_config_pattern>
65 
66## Project with AutoLoad Configuration
67 
68<project_config_pattern type="with_autoload">
69```yaml
70name: project-name
71version: 0.1.0
72
73workflows:
74  - source: ./workflow.yaml
75 
76# AutoLoad configuration for discovering agents and tools
77autoload:
78  enabled: true
79  strict: true
80  include:
81    - "agents/*.yaml"
82    - "tools/*.yaml"
83  exclude:
84    - "**/*~"
85    - "**/*.bak"
86    - "**/*.tmp"
87
88runtime:
89  permissions:
90    - --allow-read
91    - --allow-net
92    - --allow-env
93```
94</project_config_pattern>
95 
96## Environment Variable Patterns
97 
98<environment_patterns type="api_keys">
99```yaml
100# Environment variable references
101api_key: "{{ .env.GROQ_API_KEY }}"
102api_key: "{{ .env.OPENAI_API_KEY }}"
103database_url: "{{ .env.DATABASE_URL }}"
104 
105# MCP environment variables
106mcps:
107  - id: external_service
108    url: "{{ .env.MCP_SERVICE_URL }}"
109    env:
110      API_KEY: "{{ .env.EXTERNAL_API_KEY }}"
111      TIMEOUT: "{{ .env.REQUEST_TIMEOUT | default \"30s\" }}"
112```
113</environment_patterns>
114