Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 30 additions & 100 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,114 +1,44 @@
# Code Studio Agent Library
# Code Studio Library

A comprehensive collection of pre-configured custom agents for Syncfusion Code Studio. These specialized agents deliver consistent expertise across end-to-end workflows, reduce setup time, enforce team standards, and make outcomes repeatable.
A comprehensive collection of pre-configured custom agents and prompts for Syncfusion Code Studio. These specialized agents deliver consistent expertise across end-to-end workflows, reduce setup time, enforce team standards, and make outcomes repeatable.

## 📖 What are Custom Agents?
This library provides ready-to-use agents and prompts that extend the capabilities of Code Studio, enabling you to:

Custom agents are specialized versions of Syncfusion Code Studio that consist of:
- **Specific instructions** that define how the AI should behave for a given task
- **Tool configurations** that control which capabilities the agent can access
- **Consistent personas** tailored to specific development roles and tasks
- **Automate Development Tasks** - Generate code, write tests, and handle deployment automation
- **Improve Code Quality** - Run performance benchmarks and API testing
- **Enhance UX/UI Design** - Access UI design and UX research agents
- **Create Documentation** - Auto-generate comprehensive codebase documentation
- **Manage Content** - Create marketing and technical content
- **Streamline Workflows** - Use pre-built prompts for common development scenarios

This repository provides ready-to-use custom agents so you can immediately benefit from specialized expertise without creating them from scratch.
## 📁 Repository Structure

## ✨ Why Use This Library?
### Custom Agents (`/agents`)
Pre-configured intelligent agents organized by domain:

### Pre-configured Expertise
- **No setup required** - Each agent comes with detailed instructions and optimal tool configurations
- **Battle-tested workflows** - Agents are designed based on real-world development scenarios
- **Consistent behavior** - Get the same quality output every time
- **Design**: UI Designer, UX Researcher
- **Documentation**: Codebase Documenter
- **Engineering**: Backend Architect, DevOps Automator, Rapid Prototyper, Test Writer
- **Marketing**: Content Creator
- **Testing**: API Tester, Performance Benchmarker, Tool Evaluator, React Test Generator

### Time Savings
- **Skip agent creation** - No need to write instructions from scratch
- **Instant productivity** - Start using specialized agents immediately
- **Team standardization** - Everyone uses the same proven agents
### Custom Prompts (`/prompts`)
Pre-built prompts and workflows for specific use cases:

### Customizable Foundation
- **Modify to fit your needs** - All agents can be customized for your workflow
- **Learn by example** - See how professional agents are structured
- **Extend functionality** - Add handoffs and tool permissions as needed

## 📥 Installation

### Option 1: Workspace Installation (Team Sharing)

For sharing agents with your team via source control:

1. **Clone this repository:**
```bash
git clone https://github.com/syncfusion/code-studio-agent-library.git
```

2. **Copy agents to your project's `.codestudio/agents/` folder:**
```bash
# Create the directory if it doesn't exist
mkdir -p YOUR-PROJECT/.codestudio/agents/

# Copy all agent files
cp code-studio-agent-library/*/*.agent.md YOUR-PROJECT/.codestudio/agents/
```

3. **Agents are automatically detected** by Code Studio - no restart needed!

### Option 2: User Profile Installation (Personal Use)

For using agents across all your projects:

1. **Download this repository**

2. **Copy agents to your user profile:**
- **Windows**: `%USERPROFILE%\.codestudio\agents\`
- **Mac/Linux**: `~/.codestudio/agents/`

3. **Code Studio automatically detects** the new agents
- Sample Dashboard workflows (compilation, linting, security, testing, reviews)

## 🚀 Quick Start

### Using Custom Agents

1. **Open Chat View** in Code Studio
2. **Click the agent dropdown** (left bottom of the chat interface)
3. **Select your desired agent** from the list
4. **Start chatting** - the agent follows its specialized instructions

📚 Learn more: [Code Studio Custom Agents Documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/custom-agents)
1. Browse the agents and prompts in their respective folders
2. Copy the desired agent or prompt configuration to your Code Studio workspace
3. Customize as needed for your specific requirements

## 📋 Complete Agent List

### 🎨 Design Department (`design/`)

- **[ui-designer](design/ui-desginer.agent.md)** - Create beautiful, functional interfaces that can be implemented quickly within rapid development cycles
- **[ux-researcher](design/ux-researcher.agent.md)** - Bridge the gap between user needs and rapid product development through lean research methodologies and actionable insights

### 🔧 Engineering Department (`engineering/`)

- **[backend-architect](engineering/backend-architect.agent.md)** - Design scalable APIs, databases, and server-side systems with proper security and performance optimization
- **[devops-automator](engineering/devops-automator.agent.md)** - Transform manual deployments into smooth, automated workflows with CI/CD pipelines and infrastructure as code
- **[rapid-prototyper](engineering/rapid-prototyper.agent.md)** - Transform ideas into functional applications at breakneck speed, build MVPs in days not weeks
- **[test-writer](engineering/test-writer.agent.md)** - Write comprehensive tests and maintain test suite integrity through intelligent test execution and repair

### 📣 Marketing Department (`marketing/`)

- **[content-creator](marketing/content-creator.agent.md)** - Generate cross-platform content from long-form blog posts to engaging video scripts and social media content

### 🧪 Testing & Benchmarking (`testing/`)

- **[api-tester](testing/api-tester.agent.md)** - Ensure APIs are battle-tested with comprehensive performance, load, and contract testing
- **[performance-benchmarker](testing/performance-benchmarker.agent.md)** - Turn sluggish applications into lightning-fast experiences through comprehensive performance testing and optimization
- **[tool-evaluator](testing/tool-evaluator.agent.md)** - Cut through marketing hype with rapid tool assessment and clear recommendations for development frameworks and services
- **[test-generator](testing/react/test-generator.agent.md)** - Agent that auto-generates Jest + React Testing Library tests for React/TypeScript code by analyzing the actual files and following your project's style

### 📄 Documentation (`documentation/`)

- **[codebase-documenter](documentation/codebase-documenter.agent.md)** - Automatically generate comprehensive documentation for codebases, ensuring clarity and maintainability.

## 💡 Best Practices

1. **Let agents work together** - Many tasks benefit from multiple agents collaborating
2. **Be specific** - Clear task descriptions help agents perform better
3. **Trust the expertise** - Agents are designed for their specific domains
4. **Iterate quickly** - Agents support rapid development and iteration
## ✨ Key Features

- **Reduced Setup Time** - Use agents out-of-the-box without extensive configuration
- **Team Standards** - Enforce consistent practices across your development team
- **Repeatable Outcomes** - Get consistent, high-quality results for common tasks
- **Extensible** - Easily customize agents and prompts for your specific needs
## 📝 License

Copyright (c) Syncfusion Inc. All rights reserved.
Expand All @@ -119,9 +49,9 @@ Licensed under the [Syncfusion](https://downloads.sfcodestudio.com/eula/v1.0/cod

- [Code Studio Documentation](https://help.syncfusion.com/code-studio)
- [Custom Agents Guide](https://help.syncfusion.com/code-studio/reference/configure-properties/custom-agents)
- [Custom Prompts Guide](https://help.syncfusion.com/code-studio/reference/configure-properties/custom-prompt)
- [Syncfusion Community Forum](https://www.syncfusion.com/forums)
- [Code Studio Download](https://www.syncfusion.com/code-studio)

---

Built with ❤️ for the Code Studio community
Built with ❤️ for the Code Studio community
106 changes: 106 additions & 0 deletions agents/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
## 📖 What are Custom Agents?

Custom agents are specialized versions of Syncfusion Code Studio that consist of:
- **Specific instructions** that define how the AI should behave for a given task
- **Tool configurations** that control which capabilities the agent can access
- **Consistent personas** tailored to specific development roles and tasks

This custom agent library provides ready-to-use custom agents so you can immediately benefit from specialized expertise without creating them from scratch.

## ✨ Why Use This custom agent?

### Pre-configured Expertise
- **No setup required** - Each agent comes with detailed instructions and optimal tool configurations
- **Battle-tested workflows** - Agents are designed based on real-world development scenarios
- **Consistent behavior** - Get the same quality output every time

### Time Savings
- **Skip agent creation** - No need to write instructions from scratch
- **Instant productivity** - Start using specialized agents immediately
- **Team standardization** - Everyone uses the same proven agents

### Customizable Foundation
- **Modify to fit your needs** - All agents can be customized for your workflow
- **Learn by example** - See how professional agents are structured
- **Extend functionality** - Add handoffs and tool permissions as needed

## 📥 Installation

### Option 1: Workspace Installation (Team Sharing)

For sharing agents with your team via source control:

1. **Clone this repository:**
```bash
git clone https://github.com/syncfusion/code-studio-library.git
```

2. **Copy agents to your project's `.codestudio/agents/` folder:**
```bash
# Create the directory if it doesn't exist
mkdir -p YOUR-PROJECT/.codestudio/agents/

# Copy all agent files
cp agent\**\*.agent.md YOUR-PROJECT/.codestudio/agents/
```

3. **Agents are automatically detected** by Code Studio - no restart needed!

### Option 2: User Profile Installation (Personal Use)

For using agents across all your projects:

1. **Download this repository**

2. **Copy agents to your user profile:**
- **Windows**: `%USERPROFILE%\.codestudio\agents\`
- **Mac/Linux**: `~/.codestudio/agents/`

3. **Code Studio automatically detects** the new agents

## 🚀 Quick Start

### Using Custom Agents

1. **Open Chat View** in Code Studio
2. **Click the agent dropdown** (left bottom of the chat interface)
3. **Select your desired agent** from the list
4. **Start chatting** - the agent follows its specialized instructions

📚 Learn more: [Code Studio Custom Agents Documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/custom-agents)

## 📋 Complete Agent List

### 🎨 Design Department (`design/`)

- **[ui-designer](design/ui-desginer.agent.md)** - Create beautiful, functional interfaces that can be implemented quickly within rapid development cycles
- **[ux-researcher](design/ux-researcher.agent.md)** - Bridge the gap between user needs and rapid product development through lean research methodologies and actionable insights

### 🔧 Engineering Department (`engineering/`)

- **[backend-architect](engineering/backend-architect.agent.md)** - Design scalable APIs, databases, and server-side systems with proper security and performance optimization
- **[devops-automator](engineering/devops-automator.agent.md)** - Transform manual deployments into smooth, automated workflows with CI/CD pipelines and infrastructure as code
- **[rapid-prototyper](engineering/rapid-prototyper.agent.md)** - Transform ideas into functional applications at breakneck speed, build MVPs in days not weeks
- **[test-writer](engineering/test-writer.agent.md)** - Write comprehensive tests and maintain test suite integrity through intelligent test execution and repair

### 📣 Marketing Department (`marketing/`)

- **[content-creator](marketing/content-creator.agent.md)** - Generate cross-platform content from long-form blog posts to engaging video scripts and social media content

### 🧪 Testing & Benchmarking (`testing/`)

- **[api-tester](testing/api-tester.agent.md)** - Ensure APIs are battle-tested with comprehensive performance, load, and contract testing
- **[performance-benchmarker](testing/performance-benchmarker.agent.md)** - Turn sluggish applications into lightning-fast experiences through comprehensive performance testing and optimization
- **[tool-evaluator](testing/tool-evaluator.agent.md)** - Cut through marketing hype with rapid tool assessment and clear recommendations for development frameworks and services
- **[test-generator](testing/react/test-generator.agent.md)** - Agent that auto-generates Jest + React Testing Library tests for React/TypeScript code by analyzing the actual files and following your project's style

### 📄 Documentation (`documentation/`)

- **[codebase-documenter](documentation/codebase-documenter.agent.md)** - Automatically generate comprehensive documentation for codebases, ensuring clarity and maintainability.

## 💡 Best Practices

1. **Let agents work together** - Many tasks benefit from multiple agents collaborating
2. **Be specific** - Clear task descriptions help agents perform better
3. **Trust the expertise** - Agents are designed for their specific domains
4. **Iterate quickly** - Agents support rapid development and iteration
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -265,16 +265,16 @@ Filename format: `{number:02d}_{safe_name}.md`
## Quality Checklist

Before completing, ensure:
- All abstractions are covered
- Every abstraction appears in at least one relationship
- All code blocks are under 10 lines
- Every code block has an explanation
- Mermaid diagrams are present and clear
- All chapter cross-references use proper links
- Tone is consistently beginner-friendly
- Examples include both inputs and outputs
- Analogies are used throughout
- Navigation is clear (prev/next chapter links)
- All abstractions are covered
- Every abstraction appears in at least one relationship
- All code blocks are under 10 lines
- Every code block has an explanation
- Mermaid diagrams are present and clear
- All chapter cross-references use proper links
- Tone is consistently beginner-friendly
- Examples include both inputs and outputs
- Analogies are used throughout
- Navigation is clear (prev/next chapter links)

## When to Use This Agent

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -195,9 +195,9 @@ Your primary responsibilities:
### Key Metrics
| Metric | Current | Target | Status |
|--------|---------|--------|--------|
| LCP | Xs | <2.5s | |
| FID | Xms | <100ms | |
| CLS | X | <0.1 | ⚠️ |
| LCP | Xs | <2.5s | |
| FID | Xms | <100ms | |
| CLS | X | <0.1 | |

### Top Bottlenecks
1. [Issue] - Impact: Xs - Fix: [Solution]
Expand Down
File renamed without changes.
Loading