Skip to content

Commit bcfae58

Browse files
jayhackjayhack
committed
.
1 parent d2481e2 commit bcfae58

File tree

6 files changed

+219
-11
lines changed

6 files changed

+219
-11
lines changed

‎docs/capabilities/pr-review.mdx‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: "PR Review Agent"
3+
sidebarTitle: "PR Review"
4+
icon: "eye"
5+
---
6+
7+
Codegen agents automatically review your pull requests, providing intelligent feedback, suggestions, and code analysis to improve code quality and catch issues before they reach production.
8+
9+
This intelligent system analyzes code changes, identifies potential problems, and provides actionable feedback to help maintain high code quality standards.
10+
11+
<Card
12+
title="Configure PR Reviews"
13+
icon="eye"
14+
href="https://codegen.com/settings/review"
15+
>
16+
Configure PR review settings at the organization level or customize per
17+
repository. Set review criteria, feedback preferences, and integration
18+
options.
19+
</Card>
20+
21+
<Tip>
22+
The PR Review Agent provides comprehensive code analysis including security
23+
vulnerabilities, performance issues, code style violations, and logical
24+
errors.
25+
</Tip>
26+
27+
## How PR Review Works
28+
29+
Codegen automatically reviews your pull requests with intelligent analysis:
30+
31+
- **Automatic Triggering:** Monitors new pull requests and code changes in real-time
32+
- **Comprehensive Analysis:** Reviews code for bugs, security issues, performance problems, and style violations
33+
- **Contextual Feedback:** Provides specific, actionable suggestions with line-by-line comments
34+
- **Integration Aware:** Understands your codebase patterns, dependencies, and architectural decisions
35+
36+
## What Triggers PR Review
37+
38+
PR review activates when:
39+
40+
- **New Pull Requests:** Any new PR opened in monitored repositories
41+
- **Code Updates:** New commits pushed to existing pull request branches
42+
- **Review Requests:** Manual review requests through GitHub or other integrations
43+
- **Scheduled Reviews:** Periodic reviews of long-running or draft pull requests
44+
45+
## The Review Process
46+
47+
When Codegen reviews a pull request, it follows this comprehensive process:
48+
49+
1. **Code Analysis:** Deep analysis of all changed files and their context
50+
2. **Pattern Recognition:** Identifies common issues, anti-patterns, and potential bugs
51+
3. **Security Scanning:** Checks for security vulnerabilities and sensitive data exposure
52+
4. **Performance Review:** Analyzes code for performance bottlenecks and optimization opportunities
53+
5. **Style Compliance:** Ensures code follows established style guides and best practices
54+
6. **Contextual Feedback:** Generates specific, actionable comments and suggestions
55+
56+
## Review Categories
57+
58+
The PR Review Agent analyzes multiple aspects of your code:
59+
60+
### Code Quality
61+
62+
- **Logic Errors:** Identifies potential bugs and logical inconsistencies
63+
- **Code Complexity:** Highlights overly complex functions that need refactoring
64+
- **Maintainability:** Suggests improvements for code readability and maintainability
65+
- **Best Practices:** Ensures adherence to language and framework best practices
66+
67+
### Security Analysis
68+
69+
- **Vulnerability Detection:** Scans for common security vulnerabilities (SQL injection, XSS, etc.)
70+
- **Sensitive Data:** Identifies potential exposure of secrets, API keys, or personal data
71+
- **Access Control:** Reviews authentication and authorization implementations
72+
- **Dependency Security:** Checks for known vulnerabilities in dependencies
73+
74+
### Performance Optimization
75+
76+
- **Algorithmic Efficiency:** Identifies inefficient algorithms and data structures
77+
- **Resource Usage:** Reviews memory usage, database queries, and API calls
78+
- **Caching Opportunities:** Suggests areas where caching could improve performance
79+
- **Scalability Concerns:** Highlights potential bottlenecks for high-traffic scenarios
80+
81+
## Configuration Options
82+
83+
The PR Review Agent can be configured at multiple levels:
84+
85+
### Organization Level
86+
87+
- **Global settings** - Configure default review behavior for all repositories
88+
- **Review criteria** - Set standards for code quality, security, and performance
89+
- **Access via** - Organization Settings → PR Review
90+
91+
### Repository Level
92+
93+
- **Per-repo customization** - Tailor review settings for specific repositories
94+
- **Language-specific rules** - Configure rules based on programming languages used
95+
- **Integration preferences** - Choose how and where review feedback is delivered
96+
- **Access via** - Repository Settings → PR Review
97+
98+
### Team Preferences
99+
100+
- **Review thoroughness** - Adjust detail level from basic to comprehensive
101+
- **Feedback style** - Choose between concise suggestions or detailed explanations
102+
- **Priority focus** - Emphasize security, performance, or code quality based on team needs
103+
104+
## GitHub Integration
105+
106+
The PR review system integrates seamlessly with GitHub:
107+
108+
- **Inline Comments:** Provides specific feedback on individual lines of code
109+
- **Review Summaries:** Creates comprehensive review summaries with overall assessment
110+
- **Status Checks:** Integrates with GitHub's review system and status checks
111+
- **Approval Workflow:** Can be configured to require addressing feedback before merging
112+
113+
## Benefits
114+
115+
- **Improved Code Quality:** Consistent, thorough reviews catch issues early in the development process
116+
- **Knowledge Sharing:** Reviews help team members learn best practices and coding standards
117+
- **Security Enhancement:** Automated security scanning reduces vulnerability risks
118+
- **Faster Reviews:** Reduces time spent on manual code reviews while maintaining quality
119+
- **Continuous Learning:** The system learns from your codebase and improves over time
120+
121+
<Note>
122+
PR Review Agent only activates for repositories where Codegen has read access
123+
and the feature is enabled. It respects your repository permissions and review
124+
workflows.
125+
</Note>

‎docs/docs.json‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
"group": "Capabilities",
3030
"pages": [
3131
"capabilities/capabilities",
32-
"capabilities/checks-autofixer"
32+
"capabilities/checks-autofixer",
33+
"capabilities/pr-review"
3334
]
3435
},
3536
{
@@ -38,11 +39,11 @@
3839
"integrations/github",
3940
"integrations/slack",
4041
"integrations/linear",
41-
"integrations/clickup",
42-
"integrations/monday",
43-
"integrations/jira",
4442
"integrations/notion",
4543
"integrations/figma",
44+
"integrations/jira",
45+
"integrations/clickup",
46+
"integrations/monday",
4647
"integrations/sentry",
4748
"integrations/circleci",
4849
"integrations/web-search",
@@ -126,7 +127,7 @@
126127
"seo": {
127128
"metatags": {
128129
"og:site_name": "Codegen",
129-
"og:title": "Codegen - Run Code Agents at Scale",
130+
"og:title": "Codegen - The SWE that Never Sleeps",
130131
"og:description": "Code agents accessible via API, Slack, Linear, Github, and more.",
131132
"og:url": "https://docs.codegen.com",
132133
"og:locale": "en_US",

‎docs/integrations/clickup.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "ClickUp Integration"
33
sidebarTitle: "ClickUp"
4-
icon: "mouse-pointer"
4+
icon: "feather"
55
---
66

77
import { COMMUNITY_SLACK_URL } from "/snippets/links.mdx";
@@ -14,7 +14,7 @@ Connect your ClickUp workspace to Codegen to enable agent interactions.
1414

1515
<Card
1616
title="Connect ClickUp Workspace"
17-
icon="mouse-pointer-2"
17+
icon="feather"
1818
href="https://codegen.com/integrations/clickup"
1919
>
2020
Authorize Codegen to access your ClickUp workspace and project data.

‎docs/integrations/mcp-servers.mdx‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "MCP Servers"
3+
sidebarTitle: "MCP Servers"
4+
icon: "server"
5+
---
6+
7+
Connect external tools and services to enhance your AI agent capabilities through Model Context Protocol (MCP) servers. Codegen allows you to connect arbitrary MCP servers that we will run and manage for your agents.
8+
9+
## Installation
10+
11+
Configure MCP servers to extend your agent capabilities with custom tools and services.
12+
13+
<Card
14+
title="Configure MCP Servers"
15+
icon="server"
16+
href="https://codegen.com/integrations/mcp"
17+
>
18+
Connect custom MCP servers to enhance your agent workflows.
19+
</Card>
20+
21+
## Capabilities
22+
23+
The MCP integration provides comprehensive extensibility for your agents:
24+
25+
- **Connect custom tools and services** - Integrate any MCP-compatible server to extend agent functionality
26+
- **Extend agent capabilities** - Add specialized tools, APIs, and data sources to your development workflow
27+
- **Managed execution** - Codegen runs and manages your MCP servers, handling infrastructure and reliability
28+
- **Secure integration** - Connect external services while maintaining security and access controls
29+
- **Repository-specific configuration** - Configure different MCP servers for different repositories and projects
30+
- **Real-time connectivity** - Agents can interact with MCP servers in real-time during task execution
31+
32+
## How It Works
33+
34+
Codegen's MCP server integration allows you to:
35+
36+
1. **Configure MCP Servers** - Add MCP server configurations through the Codegen interface
37+
2. **Repository Integration** - Associate MCP servers with specific repositories for targeted functionality
38+
3. **Agent Access** - Agents automatically discover and use available MCP server tools during execution
39+
4. **Managed Infrastructure** - Codegen handles server deployment, scaling, and maintenance
40+
41+
## Supported MCP Servers
42+
43+
You can connect any MCP-compatible server, including:
44+
45+
- **Database connectors** - Connect to PostgreSQL, MySQL, MongoDB, and other databases
46+
- **API integrations** - Access REST APIs, GraphQL endpoints, and web services
47+
- **Development tools** - Integrate with testing frameworks, deployment tools, and CI/CD systems
48+
- **Custom business logic** - Add company-specific tools and workflows
49+
- **External services** - Connect to cloud services, monitoring tools, and third-party platforms
50+
51+
## Configuration
52+
53+
MCP servers are configured per repository using a JSON configuration file. The configuration includes:
54+
55+
- **Server details** - URL, authentication, and connection parameters
56+
- **Tool mapping** - Define which tools are available to agents
57+
- **Access controls** - Specify permissions and security settings
58+
- **Environment variables** - Configure server-specific settings and secrets
59+
60+
## Permissions
61+
62+
The Codegen MCP integration requires the following permissions:
63+
64+
- **Connect to external MCP servers** - Establish connections to your configured servers
65+
- **Execute custom tool functions** - Run tools and commands provided by MCP servers
66+
- **Access server-provided resources** - Read and write data through MCP server interfaces
67+
- **Manage server configurations** - Update and modify MCP server settings
68+
69+
## How Agents Use MCP Servers
70+
71+
Agents leverage MCP servers to:
72+
73+
- **Extend Functionality:** Access tools and capabilities beyond built-in agent features
74+
- **Connect External Systems:** Interact with databases, APIs, and services specific to your workflow
75+
- **Custom Workflows:** Execute company-specific processes and business logic
76+
- **Data Integration:** Access and manipulate data from various sources and formats
77+
- **Specialized Tools:** Use domain-specific tools for testing, deployment, monitoring, and more
78+
79+
<Note>
80+
MCP server integration allows for powerful extensibility but requires careful
81+
configuration to ensure security and proper access controls.
82+
</Note>

‎docs/integrations/monday.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Monday.com Integration"
33
sidebarTitle: "Monday.com"
4-
icon: "kanban"
4+
icon: "fan"
55
---
66

77
Integrate Codegen with your Monday.com workspace to enable AI-powered project management with intelligent task automation. Codegen can create and update items, manage boards, and keep your team synchronized across development workflows.
@@ -12,7 +12,7 @@ Connect your Monday.com workspace to Codegen to enable agent interactions.
1212

1313
<Card
1414
title="Connect Monday.com Workspace"
15-
icon="monday"
15+
icon="fan"
1616
href="https://codegen.com/integrations/monday"
1717
>
1818
Authorize Codegen to access your Monday.com workspace and project boards.

‎docs/integrations/sentry.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Sentry Integration"
33
sidebarTitle: "Sentry"
4-
icon: "pyramid"
4+
icon: "triangle"
55
---
66

77
import { COMMUNITY_SLACK_URL } from "/snippets/links.mdx";
@@ -14,7 +14,7 @@ Connect your Sentry organization to Codegen to enable agent interactions with er
1414

1515
<Card
1616
title="Connect Sentry Organization"
17-
icon="sentry"
17+
icon="triangle"
1818
href="https://codegen.com/integrations/sentry"
1919
>
2020
Authorize Codegen to access your Sentry organization and error data.

0 commit comments

Comments
 (0)