AGENTS.md Integration

AGENTS.md is a structured context file that provides SEO intelligence in any IDE, and compatible with any AI coding assistant. Download it from your Rampify dashboard, place it in your project root, and any AI can read and act on your SEO data.

What is AGENTS.md?#

AGENTS.md is an open markdown standard designed to guide AI coding agents through projects. Think of it as a "README for AI assistants" - a predictable location containing context and guidance that help AI tools work effectively on your codebase.

Rampify generates an AGENTS.md file that contains:

• Your site's current SEO issues and action items
• Business context (industry, target audience, brand voice)
• Prioritized fixes grouped by severity
• Affected URLs with clickable links
• Code snippets and fix instructions
• MCP tool recommendations for each issue

How It Works#

1. Dashboard                    2. Your Project               3. AI Assistant
┌─────────────────┐            ┌─────────────────┐            ┌─────────────────┐
│  Action Plan    │  Download  │  project-root/  │   Reads    │  Claude, GPT-4  │
│  ────────────   │ ────────→  │  ├── AGENTS.md  │ ────────→  │  Cursor, Gemini │
│  SEO Issues     │            │  ├── src/       │            │  Any AI tool    │
│  Priorities     │            │  └── ...        │            │                 │
└─────────────────┘            └─────────────────┘            └─────────────────┘

1. Visit your Action Plan in the Rampify dashboard
2. Click "Download AGENTS.md" to get your current SEO context
3. Place the file in your project root (alongside package.json)
4. Start coding - AI assistants automatically read the file

Download Your AGENTS.md#

1. Log in to Rampify
2. Navigate to your site's Action Plan tab
3. Click "Download AGENTS.md" button
4. Save the file to your project root

The file is regenerated each time you download, ensuring you always get the latest SEO data.

What's Included#

Your generated AGENTS.md contains several sections:

Header#

Basic metadata about your site and when the file was generated:

# SEO Context for example.com

**Last Updated:** Nov 28, 2025, 3:45 PM
**Generated by:** [Rampify](https://rampify.dev)
**View in Dashboard:** [Go to Rampify](https://rampify.dev/clients/.../actions)

Business Context#

If you've completed your Business Profile, this section provides AI assistants with context about your business:

## Business Context

**About This Business**
We're building developer tools for modern web frameworks...

**Industry & Business Model**
- Industry: Developer Tools
- Business Model: B2B SaaS
- Company Stage: Growth

**Content Strategy**
- Target Audience: technical founders, developers
- Target Keywords: SEO automation, developer SEO
- Brand Voice: technical but approachable

This context helps AI assistants generate content and recommendations that match your brand voice and target audience.

Priority Actions#

The core of the file - your SEO issues organized by priority:

## Priority Actions

### Critical (Fix First)

- [ ] **Broken Links (3 affected)**
      - **Affected:** 3 pages
      - **Issue:** Pages returning 404 errors
      - **Impact:** Broken links hurt user experience and SEO
      - **Recommended Tool:** Fix broken links, then run `mcp__rampify__crawl_site`
      - **Affected URLs:**
        - [/old-blog-post](https://example.com/old-blog-post)
        - [/deprecated-feature](https://example.com/deprecated-feature)

### High Priority

- [ ] **Missing Meta Descriptions (12 affected)**
      - **Affected:** 12 pages
      - **Issue:** Pages missing meta description tags
      - **Recommended Tool:** Use `mcp__rampify__generate_meta`
      - **Files to Edit:**
        - `content/blog/*.mdx (12 files)`

Each action item includes:

• Checkbox format for tracking progress
• Affected count showing how many pages have the issue
• Issue description explaining the problem
• Impact statement describing why it matters
• Fix instructions with specific guidance
• MCP tool recommendations for automated fixes
• File paths suggesting where to make changes
• Affected URLs as clickable links

MCP Tools Reference#

A reference section explaining available Rampify MCP tools:

## Rampify MCP Tools Reference

> For AI Agents: When the user asks you to fix SEO issues,
> you can call these MCP tools directly.

| Tool | Purpose |
|------|---------|
| `mcp__rampify__get_issues` | Get site-wide SEO issues |
| `mcp__rampify__generate_meta` | Generate optimized meta tags |
| `mcp__rampify__generate_schema` | Generate schema.org markup |

This section helps AI assistants understand they can use MCP tools if available, or fall back to manual fixes if not.

AGENTS.md vs MCP Server#

Both integration methods provide the same SEO data in different formats:

When to Use AGENTS.md#

• Your IDE doesn't support MCP
• You want the simplest possible setup
• You need to work offline
• You're sharing context with team members
• You want to review the exact data AI sees

When to Use MCP Server#

• Your IDE supports MCP (Cursor, Claude Code, VS Code, etc.)
• You want always-current SEO data
• You frequently ask SEO questions while coding
• You want to trigger site scans from your IDE

AI Assistant Compatibility#

AGENTS.md works with any AI that can read markdown files:

AI Coding Assistants#

• Claude (Claude.ai, Claude Code, API)
• GPT-4 (ChatGPT, OpenAI API)
• Gemini (Google AI Studio, API)
• Cursor (reads project files automatically)
• GitHub Copilot (workspace context)
• Continue.dev (VS Code extension)
• Cody (Sourcegraph)

How AI Assistants Find the File#

Most AI coding tools automatically read files from your project root. When you ask about SEO:

You: "What SEO issues does my site have?"

AI: *Reads AGENTS.md*
"Based on your AGENTS.md file, I can see 3 critical issues and 5 high-priority
items. The most urgent is 3 broken links returning 404 errors. Would you like
me to help fix them?"

Explicit Reference#

If your AI doesn't automatically find the file, reference it explicitly:

"Read AGENTS.md and tell me what SEO issues I should fix first"

Best Practices#

File Location#

Place AGENTS.md in your project root, alongside package.json:

project-root/
├── AGENTS.md          # SEO context for AI assistants
├── README.md          # Human-readable project docs
├── package.json
├── src/
└── ...

Keep It Current#

Re-download AGENTS.md when:

• You deploy changes that fix SEO issues
• You run a new site scan in Rampify
• You start a new development session
• Your AI seems to have outdated information

Git Tracking#

Option 1: Track in git (recommended for teams)

• Everyone sees the same SEO context
• Changes visible in pull requests
• Easy to see what was fixed over time

Option 2: Gitignore (for frequently changing sites)

• Add AGENTS.md to .gitignore
• Each developer downloads their own copy
• Avoids merge conflicts from frequent updates

Complement with Business Profile#

Complete your Business Profile in Rampify to include rich business context in AGENTS.md. This helps AI assistants:

• Match your brand voice when writing content
• Target the right audience in recommendations
• Understand your business goals and priorities
• Generate relevant keyword suggestions

File Format Details#

AGENTS.md follows the agents.md open standard:

• Pure markdown - no custom syntax required
• Section-based - clear headings organize content
• Hierarchical priority - critical issues first
• Actionable format - checkbox items for tracking
• Link-rich - URLs, dashboard links, documentation

The format is designed to be readable by both humans and AI assistants, making it easy to review what context your AI receives.