agentrules-architect

🥈Silver

AgentRules Architect generates AGENTS.md files for coding agents like Codex, Claude Code, and Cursor IDE. It helps developers and operations teams standardize agent configurations and workflows. The tool connects to AI coding agents to streamline setup and maintenance of agent rules.

114150Updated 2w ago

Intermediate30min to implementautomation

Saves ~30 min per use

Quick InstallView Source

git clone https://github.com/trevor-nichols/agentrules-architect.git

Works with:

Claude

Overview

About This Skill

How to Use

[{"step":1,"action":"Identify your project's core components by running `ls -la` in your project root and noting the primary tech stack (e.g., TypeScript, Python, Java).","tip":"Use `npx agentrules-architect --scan` to automatically detect your tech stack and project structure."},{"step":2,"action":"Gather your organization's security policies (e.g., SOC 2, GDPR) and deployment workflows (e.g., GitHub Actions, Jenkins). Store these in a `docs/policies/` directory.","tip":"If policies are in a shared drive, export them as markdown files first."},{"step":3,"action":"Run the agentrules-architect tool with your project details: `npx agentrules-architect --project Acme-Ecommerce --platform Cursor --stack TypeScript,React,Node --policies SOC2,GDPR --workflow GitHubActions`.","tip":"Use `--output` to save directly to `AGENTS.md` or `--dry-run` to preview changes."},{"step":4,"action":"Review the generated AGENTS.md file, especially the workflow automation and error handling sections. Customize any placeholder values (e.g., AWS cluster names).","tip":"Test the workflow snippets in a staging environment before merging to main."},{"step":5,"action":"Commit the AGENTS.md file to your repository and configure your AI coding agent (e.g., Cursor, Claude Code) to use it as a reference. Update it whenever your tech stack or policies change.","tip":"Set up a GitHub Actions workflow to validate AGENTS.md syntax on PRs."}]

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/trevor-nichols/agentrules-architect

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Generate an AGENTS.md file for [PROJECT_NAME] using [AGENT_PLATFORM] that includes: 1) Project-specific rules for [LANGUAGE/TECH_STACK], 2) Security and compliance guidelines for [COMPANY_POLICY], 3) Workflow automation steps for [DEPLOYMENT_PIPELINE], and 4) Error handling procedures for [COMMON_ISSUES]. Format the output as a markdown file with clear sections and code blocks for configuration snippets.

Example Output

```markdown
# AGENTS.md - Project: Acme E-Commerce Platform
**Agent Platform:** Cursor IDE
**Last Updated:** 2024-05-15

## 1. Project-Specific Rules
**Tech Stack:** TypeScript, React, Node.js, PostgreSQL
- **TypeScript:** Always use strict mode and prefer interfaces over types for public APIs.
- **React:** Components must follow the `src/components/{domain}/{ComponentName}.tsx` structure.
- **API Design:** RESTful endpoints must include OpenAPI 3.0 specs in `docs/api-specs/`.
- **Database:** All migrations must be idempotent and include rollback scripts.

## 2. Security & Compliance
**Company Policy:** SOC 2 Type II, GDPR
- **Secrets:** Never log API keys or database credentials. Use environment variables only.
- **Data Handling:** Mask PII in logs and error messages. Use `src/utils/privacy.ts` for redaction.
- **Dependencies:** Run `npm audit` weekly and block PRs with critical vulnerabilities.
- **Access Control:** Use RBAC with least privilege. Audit logs must be stored for 90 days.

## 3. Workflow Automation
**Deployment Pipeline:** GitHub Actions → AWS ECS
```yaml
# .github/workflows/deploy.yml
name: Deploy to Staging
on:
  push:
    branches: [main]
jobs:
  deploy:
    steps:
      - uses: actions/checkout@v4
      - run: npm ci
      - run: npm run lint
      - run: npm run test:unit
      - run: npm run build
      - run: aws ecs update-service --cluster acme-staging --service acme-api --force-new-deployment
```

## 4. Error Handling
**Common Issues:** Database connection timeouts, API rate limits
- **Database Timeouts:** Implement exponential backoff in `src/db/connection.ts`.
- **API Rate Limits:** Use `src/utils/rate-limiter.ts` with 1000 RPM for external APIs.
- **Logging:** All errors must include context (e.g., user ID, request ID). Use `src/logger.ts`.

## 5. Agent-Specific Settings
**Cursor IDE:**
- Enable `experimental.autoImport` for TypeScript.
- Set `maxTokens` to 4096 for complex refactoring tasks.
- Use `src/agents/rules.ts` for custom validation rules.
```