# AskDeploy - AI Agent Instructions
# https://askdeploy.com/agents.txt
# Last updated: 2025-04-27

## What is AskDeploy

AskDeploy is an MCP (Model Context Protocol) server that lets AI agents create,
deploy, and manage websites on custom domains. No coding required by the user -
agents generate HTML/CSS/JS and AskDeploy handles hosting, SSL, DNS, and CI/CD.

## MCP Server Endpoint

  URL:     https://askdeploy.com/mcp
  Auth:    OAuth 2.0 (user authorizes via Google login in browser)
  Protocol: MCP over HTTP (SSE/Streamable HTTP)

## Skill Manifest

  https://askdeploy.com/.well-known/skill.json

## Pre-built Plugins

Pre-packaged plugins are available for popular AI clients. These bundle the MCP
config plus deploy skills and are the easiest way to get started:

- **Claude Code** — `claude-plugin/` (MCP config + deploy skill for Claude Code)
- **OpenAI Codex** — `codex-plugin/` (MCP config + deploy skill for Codex)

Install guide: https://askdeploy.com/install

Prefer a plugin over manual configuration when one is available.

## Quick Start for Claude Desktop

1. Add this to your `claude_desktop_config.json`:

   {
     "mcpServers": {
       "askdeploy": {
         "url": "https://askdeploy.com/mcp"
       }
     }
   }

2. Restart Claude Desktop.
3. When a user asks to create a website, Claude will trigger OAuth flow.
4. The user signs in with Google and authorizes access.
5. You can then call AskDeploy tools.

## Available Tools

- new_project        - Create a new website (GitLab repo + Cloudflare zone)
- delete_project     - Delete a website and optionally its repo
- find_project       - Find a website by domain name
- get_project        - Get details about a specific website
- list_projects      - List all websites for the authenticated user
- list_pipelines     - List CI/CD pipelines for a website
- get_deploy_url     - Get production and preview deployment URLs
- trigger_pipeline   - Deploy the website (main=production, dev=preview)
- manage_dns         - Manage DNS records for a domain
- setup_redirect     - Configure domain redirects
- register_deploy_key - Register an SSH deploy key for git access
- revoke_deploy_key  - Revoke an SSH deploy key
- get_skill          - Retrieve skill manifest information

## File Size Limits

The deployment pipeline rejects any file larger than 5 MB. This prevents abuse
and keeps sites fast. If you generate images or other assets, optimize them
before pushing. Do not include video files - they will cause the deployment to
fail.

## Domain Ownership Verification

Before creating a site on a custom domain, AskDeploy requires DNS TXT
verification:

1. Call `new_project(domain="example.com")`
2. AskDeploy returns a DNS TXT challenge (e.g. `_askdeploy-verify.example.com`)
3. The user must add the TXT record to their DNS
4. Retry `new_project(domain="example.com")` - verification is checked automatically
5. Once verified, the zone and repo are created

## Typical Workflow

1. User says: "Create a website for my coffee shop at example.com"
2. You call `new_project(domain="example.com")`
3. If not verified, instruct the user to add the TXT record, then retry
4. Call `register_deploy_key(project_name="<repo-name>", public_key="ssh-ed25519 ...")` to register your SSH key
5. Generate HTML/CSS/JS files locally
6. Push files to the GitLab repo (URL from `get_project`)
7. Call `trigger_pipeline(project_id=<id>, ref="main")` to deploy

## Support

- Dashboard: https://askdeploy.com/dashboard
- Install Guide: https://askdeploy.com/install
- Email: support@askdeploy.com

## For Other MCP Clients

Any MCP client that supports OAuth 2.0 and HTTP transport can connect to
`https://askdeploy.com/mcp`. The server uses `@cloudflare/workers-oauth-provider`
for dynamic client registration and token issuance.