| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 20 | 3 | 0% |
| Commands | 0 | 12 | 0 | 0% |
| Section tags | 1 | 7 | 0 | 13% |
What each file covers
Sections
0 shared · 20 only in A · 3 only in B- − Development Guide
- − Project Overview
- − Development Commands
- − Essential Commands
- − Quick setup
- − Start development server with hot reload
- − Run tests (excludes E2E/slow tests)
- − Run all tests including E2E
- − Format and lint code (ALWAYS run before committing)
- − Run specific test
- − Database Commands
- − Architecture & Project Structure
- − 🚨 CRITICAL: Follow All Development Standards
- − Development Workflow
- − Pre-Commit Requirements
- − Development Process
- − Key Development Notes
- − Task Management
- − Rule Management
- − Compozy Configuration Examples
- + Compozy Agent Configuration Examples
- + Basic Agent Configuration
- + Agent with MCP Integration
Commands
0 shared · 12 only in A · 0 only in B- − make deps && make start-docker && make migrate-up
- − make dev
- − make test
- − make fmt && make lint
- − go test -v ./engine/task -run TestExecutor_Execute
- − make migrate-up
- − make migrate-down
- − make migrate-status
- − make reset-db
- − make fmt && make lint && make test
- − make lint
- − make migrate-create name=<name>
Section tags
1 shared · 7 only in A · 0 only in B- − setup
- − test
- − lint-format
- − architecture
- − testing-strategy
- − git-pr
- − database
- agent-behaviour
Line diff
compozy/gograph · GEMINI.md
@@ −1 @@
1# Development Guide
2
3This file provides comprehensive guidance for working with the Compozy codebase, including development commands, standards, and workflow patterns.
4
5<critical>
6**MANDATORY REQUIREMENTS:**
7- **ALWAYS** check dependent files APIs before write tests to avoid write wrong code
8- **ALWAYS** verify against PRD and tech specs - NEVER make assumptions
9- **NEVER** use workarounds, especially in tests - implement proper solutions
10- **MUST** follow all established project standards:
11 - Architecture patterns: `.cursor/rules/architecture.mdc`
12 - Go coding standards: `.cursor/rules/go-coding-standards.mdc`
13 - Testing requirements: `.cursor/rules/testing-standards.mdc`
14 - API standards: `.cursor/rules/api-standards.mdc`
15 - Security & quality: `.cursor/rules/quality-security.mdc`
16- **MUST** run `make lint` and `make test` before completing ANY subtask
17- **MUST** follow `.cursor/rules/task-review.mdc` workflow for parent tasks
18**Enforcement:** Violating these standards results in immediate task rejection.
19</critical>
20
21## Project Overview
22
23Compozy is a **workflow orchestration engine for AI agents** that enables building AI-powered applications through declarative YAML configuration and a robust Go backend. It integrates with various LLM providers and supports the Model Context Protocol (MCP) for extending AI capabilities.
24
25## Development Commands
26
27### Essential Commands
28
29```bash
30# Quick setup
31make deps && make start-docker && make migrate-up
32
33# Start development server with hot reload
34make dev
35
36# Run tests (excludes E2E/slow tests)
37make test
38
39# Run all tests including E2E
40make test
41
42# Format and lint code (ALWAYS run before committing)
43make fmt && make lint
44
45# Run specific test
46go test -v ./engine/task -run TestExecutor_Execute
47```
48
49### Database Commands
50
51```bash
52make migrate-up # Apply migrations
53make migrate-down # Rollback last migration
54make migrate-status # Check migration status
55make reset-db # Reset database completely
56```
57
58## Architecture & Project Structure
59
60**📁 Complete project structure, technology stack, and architectural patterns:** See [project-structure.mdc](mdc:.cursor/rules/project-structure.mdc)
61
62## 🚨 CRITICAL: Follow All Development Standards
63
64**📋 MANDATORY: Review and follow ALL established coding standards:**
65
66- **Code Formatting & Line Spacing**: [no_linebreaks.mdc](mdc:.cursor/rules/no_linebreaks.mdc) - NEVER add blank lines inside function bodies
67- **Go Coding Standards**: [go-coding-standards.mdc](mdc:.cursor/rules/go-coding-standards.mdc) - Function limits, error handling, documentation policy
68- **Testing Standards**: [testing-standards.mdc](mdc:.cursor/rules/testing-standards.mdc) - MANDATORY `t.Run("Should...")` pattern, testify usage
69- **Go Implementation Patterns**: [go-patterns.mdc](mdc:.cursor/rules/go-patterns.mdc) - Canonical implementations of architecture principles
70- **Architecture Principles**: [architecture.mdc](mdc:.cursor/rules/architecture.mdc) - SOLID principles, Clean Architecture, DRY
71- **Code Quality & Security**: [quality-security.mdc](mdc:.cursor/rules/quality-security.mdc) - Linting rules, security requirements
72- **Required Libraries**: [core-libraries.mdc](mdc:.cursor/rules/core-libraries.mdc) - Mandatory library choices and usage patterns
73- **API Development**: [api-standards.mdc](mdc:.cursor/rules/api-standards.mdc) - RESTful design, versioning, documentation
74- **Code Review Process**: [review-checklist.mdc](mdc:.cursor/rules/review-checklist.mdc) - Pre-review requirements and checklist
75
76## Development Workflow
77
78### Pre-Commit Requirements
79
80**ALWAYS run before committing:**
81
82```bash
83make fmt && make lint && make test
84```
85
86### Development Process
87
881. **API changes:** Update Swagger annotations (`swag` comments)
892. **Schema changes:** Create migrations with `make migrate-create name=<name>`
903. **New features:** Include comprehensive tests following [testing-standards.mdc](mdc:.cursor/rules/testing-standards.mdc)
914. **Task completion:** Follow [task-review.mdc](mdc:.cursor/rules/task-review.mdc) for mandatory code review workflow via Zen MCP tools
925. **Backwards Compatibility:** See [backwards-compatibility.mdc](mdc:.cursor/rules/backwards-compatibility.mdc) - NOT REQUIRED during development phase
93
94### Key Development Notes
95
96- **Logging:** Use [core-libraries.mdc](mdc:.cursor/rules/core-libraries.mdc) for structured logging patterns
97- **Core types:** Use `core.ID` for UUIDs, `core.Ref` for polymorphic references
98- **Dependencies:** Mock external dependencies in tests when necessary (see [testing-standards.mdc](mdc:.cursor/rules/testing-standards.mdc))
99
100## Task Management
101
102For task-based development workflows, see these rule files:
103
104- [prd-create.mdc](mdc:.cursor/rules/prd-create.mdc) - PRD Creation
105- [prd-tech-spec.mdc](mdc:.cursor/rules/prd-tech-spec.mdc) - Technical Specifications
106- [task-generate-list.mdc](mdc:.cursor/rules/task-generate-list.mdc) - Task List Generation
107- [task-developing.mdc](mdc:.cursor/rules/task-developing.mdc) - Task Development
108- [task-review.mdc](mdc:.cursor/rules/task-review.mdc) - Task Completion with Zen MCP code review
109
110## Rule Management
111
112The development rules are actively maintained and improved:
113
114- **Rule Management**: [cursor_rules.mdc](mdc:.cursor/rules/cursor_rules.mdc) - Comprehensive guidelines for creating, maintaining, and improving rules
115
116## Compozy Configuration Examples
117
118For YAML configuration patterns and examples:
119
120- **Project Configuration**: [compozy-project-config.mdc](mdc:.cursor/rules/compozy-project-config.mdc) - Project setup patterns
121- **Task Patterns**: [compozy-task-patterns.mdc](mdc:.cursor/rules/compozy-task-patterns.mdc) - Workflow task configurations
122- **Agent Configuration**: [compozy-agent-config.mdc](mdc:.cursor/rules/compozy-agent-config.mdc) - AI agent setup patterns
123- **Shared Patterns**: [compozy-shared-patterns.mdc](mdc:.cursor/rules/compozy-shared-patterns.mdc) - MCP, templates, and references
124- **Configuration Index**: [compozy-examples.mdc](mdc:.cursor/rules/compozy-examples.mdc) - Overview and cross-references
125
126**All rule files are located in `.cursor/rules/` and use semantic XML tags for better context and AI understanding.**
127
128The project uses Go 1.24+ features and requires external dependencies to be mocked in tests when necessary.
129
compozy/gograph · .cursor/rules/compozy-agent-config.mdc
@@ +1 @@
1---
2description: "Agent configuration patterns and examples for Compozy agents"
3globs:
4 - "**/agents/*.yaml"
5 - "**/agent.yaml"
6alwaysApply: false
7---
8# Compozy Agent Configuration Examples
9
10<configuration_overview type="agent_config">
11Agent configuration defines AI agents with instructions, tools, actions, and MCP integrations for workflow execution.
12</configuration_overview>
13
14## Basic Agent Configuration
15
16<agent_config_pattern type="basic_agent">
17```yaml
18resource: agent
19id: tourist_guide
20description: A helpful tourist guide assistant
21version: 0.1.0
22
23config:
24 provider: groq
25 model: llama-3.3-70b-versatile
26 api_key: "{{ .env.GROQ_API_KEY }}"
27
28instructions: |
29 You are a helpful tourist guide assistant specialized in {{ .workflow.input.city }}
30 Your capabilities:
31 - Provide thoughtful recommendations for activities
32 - Suggest appropriate clothing based on weather
33 Always respond in valid JSON format when json_mode is enabled.
34
35tools:
36 - $ref: local::tools.#(id=="weather_tool")
37
38actions:
39 - id: get_weather
40 prompt: |
41 What is the current weather in {{ .workflow.input.city }}?
42
43 - id: suggest_activities
44 json_mode: true
45 prompt: |
46 Given the current conditions: {{ .tasks.weather.output | toJson }}
47 Suggest appropriate activities for these weather conditions
48 output:
49 type: object
50 properties:
51 activities:
52 type: array
53 items:
54 type: string
55 required:
56 - activities
57```
58</agent_config_pattern>
59
60## Agent with MCP Integration
61
62<agent_config_pattern type="agent_with_mcp">
63```yaml
64resource: agent
65id: file_reader
66description: An agent that uses MCP tools to read and list files
67version: 0.1.0
68
69config:
70 provider: groq
71 model: llama-3.3-70b-versatile
72 api_key: "{{ .env.GROQ_API_KEY }}"
73
74instructions: |
75 You are a file management assistant that uses MCP tools.
76 Use MCP tools to check what files exist and read contents when needed.
77
78mcps:
79 - id: file_server
80 transport: stdio
81 command: npx
82 args:
83 - -y
84 - "@modelcontextprotocol/server-filesystem"
85 - "./"
86 proto: "2025-03-26"
87 start_timeout: 15s
88
89actions:
90 - id: list_saved_files
91 prompt: |
92 Use MCP tools to list files in the current directory.
93 Look for results.json and results.txt files.
94 Use the read_directory MCP tool to list contents.
95```
96</agent_config_pattern>
97
@@ −1 +1 @@
1−# Development Guide
1+---
2+description: "Agent configuration patterns and examples for Compozy agents"
3+globs:
4+ - "**/agents/*.yaml"
5+ - "**/agent.yaml"
6+alwaysApply: false
7+---
8+# Compozy Agent Configuration Examples
29
3−This file provides comprehensive guidance for working with the Compozy codebase, including development commands, standards, and workflow patterns.
10+<configuration_overview type="agent_config">
11+Agent configuration defines AI agents with instructions, tools, actions, and MCP integrations for workflow execution.
12+</configuration_overview>
413
5−<critical>
6−**MANDATORY REQUIREMENTS:**
7−- **ALWAYS** check dependent files APIs before write tests to avoid write wrong code
8−- **ALWAYS** verify against PRD and tech specs - NEVER make assumptions
9−- **NEVER** use workarounds, especially in tests - implement proper solutions
10−- **MUST** follow all established project standards:
11− - Architecture patterns: `.cursor/rules/architecture.mdc`
12− - Go coding standards: `.cursor/rules/go-coding-standards.mdc`
13− - Testing requirements: `.cursor/rules/testing-standards.mdc`
14− - API standards: `.cursor/rules/api-standards.mdc`
15− - Security & quality: `.cursor/rules/quality-security.mdc`
16−- **MUST** run `make lint` and `make test` before completing ANY subtask
17−- **MUST** follow `.cursor/rules/task-review.mdc` workflow for parent tasks
18−**Enforcement:** Violating these standards results in immediate task rejection.
19−</critical>
14+## Basic Agent Configuration
2015
21−## Project Overview
16+<agent_config_pattern type="basic_agent">
17+```yaml
18+resource: agent
19+id: tourist_guide
20+description: A helpful tourist guide assistant
21+version: 0.1.0
2222
23−Compozy is a **workflow orchestration engine for AI agents** that enables building AI-powered applications through declarative YAML configuration and a robust Go backend. It integrates with various LLM providers and supports the Model Context Protocol (MCP) for extending AI capabilities.
23+config:
24+ provider: groq
25+ model: llama-3.3-70b-versatile
26+ api_key: "{{ .env.GROQ_API_KEY }}"
2427
25−## Development Commands
28+instructions: |
29+ You are a helpful tourist guide assistant specialized in {{ .workflow.input.city }}
30+ Your capabilities:
31+ - Provide thoughtful recommendations for activities
32+ - Suggest appropriate clothing based on weather
33+ Always respond in valid JSON format when json_mode is enabled.
2634
27−### Essential Commands
35+tools:
36+ - $ref: local::tools.#(id=="weather_tool")
2837
29−```bash
30−# Quick setup
31−make deps && make start-docker && make migrate-up
38+actions:
39+ - id: get_weather
40+ prompt: |
41+ What is the current weather in {{ .workflow.input.city }}?
3242
33−# Start development server with hot reload
34−make dev
35−
36−# Run tests (excludes E2E/slow tests)
37−make test
38−
39−# Run all tests including E2E
40−make test
41−
42−# Format and lint code (ALWAYS run before committing)
43−make fmt && make lint
44−
45−# Run specific test
46−go test -v ./engine/task -run TestExecutor_Execute
43+ - id: suggest_activities
44+ json_mode: true
45+ prompt: |
46+ Given the current conditions: {{ .tasks.weather.output | toJson }}
47+ Suggest appropriate activities for these weather conditions
48+ output:
49+ type: object
50+ properties:
51+ activities:
52+ type: array
53+ items:
54+ type: string
55+ required:
56+ - activities
4757 ```
58+</agent_config_pattern>
4859
49−### Database Commands
60+## Agent with MCP Integration
5061
51−```bash
52−make migrate-up # Apply migrations
53−make migrate-down # Rollback last migration
54−make migrate-status # Check migration status
55−make reset-db # Reset database completely
56−```
62+<agent_config_pattern type="agent_with_mcp">
63+```yaml
64+resource: agent
65+id: file_reader
66+description: An agent that uses MCP tools to read and list files
67+version: 0.1.0
5768
58−## Architecture & Project Structure
69+config:
70+ provider: groq
71+ model: llama-3.3-70b-versatile
72+ api_key: "{{ .env.GROQ_API_KEY }}"
5973
60−**📁 Complete project structure, technology stack, and architectural patterns:** See [project-structure.mdc](mdc:.cursor/rules/project-structure.mdc)
74+instructions: |
75+ You are a file management assistant that uses MCP tools.
76+ Use MCP tools to check what files exist and read contents when needed.
6177
62−## 🚨 CRITICAL: Follow All Development Standards
78+mcps:
79+ - id: file_server
80+ transport: stdio
81+ command: npx
82+ args:
83+ - -y
84+ - "@modelcontextprotocol/server-filesystem"
85+ - "./"
86+ proto: "2025-03-26"
87+ start_timeout: 15s
6388
64−**📋 MANDATORY: Review and follow ALL established coding standards:**
65−
66−- **Code Formatting & Line Spacing**: [no_linebreaks.mdc](mdc:.cursor/rules/no_linebreaks.mdc) - NEVER add blank lines inside function bodies
67−- **Go Coding Standards**: [go-coding-standards.mdc](mdc:.cursor/rules/go-coding-standards.mdc) - Function limits, error handling, documentation policy
68−- **Testing Standards**: [testing-standards.mdc](mdc:.cursor/rules/testing-standards.mdc) - MANDATORY `t.Run("Should...")` pattern, testify usage
69−- **Go Implementation Patterns**: [go-patterns.mdc](mdc:.cursor/rules/go-patterns.mdc) - Canonical implementations of architecture principles
70−- **Architecture Principles**: [architecture.mdc](mdc:.cursor/rules/architecture.mdc) - SOLID principles, Clean Architecture, DRY
71−- **Code Quality & Security**: [quality-security.mdc](mdc:.cursor/rules/quality-security.mdc) - Linting rules, security requirements
72−- **Required Libraries**: [core-libraries.mdc](mdc:.cursor/rules/core-libraries.mdc) - Mandatory library choices and usage patterns
73−- **API Development**: [api-standards.mdc](mdc:.cursor/rules/api-standards.mdc) - RESTful design, versioning, documentation
74−- **Code Review Process**: [review-checklist.mdc](mdc:.cursor/rules/review-checklist.mdc) - Pre-review requirements and checklist
75−
76−## Development Workflow
77−
78−### Pre-Commit Requirements
79−
80−**ALWAYS run before committing:**
81−
82−```bash
83−make fmt && make lint && make test
89+actions:
90+ - id: list_saved_files
91+ prompt: |
92+ Use MCP tools to list files in the current directory.
93+ Look for results.json and results.txt files.
94+ Use the read_directory MCP tool to list contents.
8495 ```
85−
86−### Development Process
87−
88−1. **API changes:** Update Swagger annotations (`swag` comments)
89−2. **Schema changes:** Create migrations with `make migrate-create name=<name>`
90−3. **New features:** Include comprehensive tests following [testing-standards.mdc](mdc:.cursor/rules/testing-standards.mdc)
91−4. **Task completion:** Follow [task-review.mdc](mdc:.cursor/rules/task-review.mdc) for mandatory code review workflow via Zen MCP tools
92−5. **Backwards Compatibility:** See [backwards-compatibility.mdc](mdc:.cursor/rules/backwards-compatibility.mdc) - NOT REQUIRED during development phase
93−
94−### Key Development Notes
95−
96−- **Logging:** Use [core-libraries.mdc](mdc:.cursor/rules/core-libraries.mdc) for structured logging patterns
97−- **Core types:** Use `core.ID` for UUIDs, `core.Ref` for polymorphic references
98−- **Dependencies:** Mock external dependencies in tests when necessary (see [testing-standards.mdc](mdc:.cursor/rules/testing-standards.mdc))
99−
100−## Task Management
101−
102−For task-based development workflows, see these rule files:
103−
104−- [prd-create.mdc](mdc:.cursor/rules/prd-create.mdc) - PRD Creation
105−- [prd-tech-spec.mdc](mdc:.cursor/rules/prd-tech-spec.mdc) - Technical Specifications
106−- [task-generate-list.mdc](mdc:.cursor/rules/task-generate-list.mdc) - Task List Generation
107−- [task-developing.mdc](mdc:.cursor/rules/task-developing.mdc) - Task Development
108−- [task-review.mdc](mdc:.cursor/rules/task-review.mdc) - Task Completion with Zen MCP code review
109−
110−## Rule Management
111−
112−The development rules are actively maintained and improved:
113−
114−- **Rule Management**: [cursor_rules.mdc](mdc:.cursor/rules/cursor_rules.mdc) - Comprehensive guidelines for creating, maintaining, and improving rules
115−
116−## Compozy Configuration Examples
117−
118−For YAML configuration patterns and examples:
119−
120−- **Project Configuration**: [compozy-project-config.mdc](mdc:.cursor/rules/compozy-project-config.mdc) - Project setup patterns
121−- **Task Patterns**: [compozy-task-patterns.mdc](mdc:.cursor/rules/compozy-task-patterns.mdc) - Workflow task configurations
122−- **Agent Configuration**: [compozy-agent-config.mdc](mdc:.cursor/rules/compozy-agent-config.mdc) - AI agent setup patterns
123−- **Shared Patterns**: [compozy-shared-patterns.mdc](mdc:.cursor/rules/compozy-shared-patterns.mdc) - MCP, templates, and references
124−- **Configuration Index**: [compozy-examples.mdc](mdc:.cursor/rules/compozy-examples.mdc) - Overview and cross-references
125−
126−**All rule files are located in `.cursor/rules/` and use semantic XML tags for better context and AI understanding.**
127−
128−The project uses Go 1.24+ features and requires external dependencies to be mocked in tests when necessary.
96+</agent_config_pattern>
12997
