Skip to content
Install

Agent setup

Connect your coding agent to Orchard, then deploy and debug from your editor or terminal.

Connect to my Orchard instance over MCP. Follow https://docs.orchard.hackclub.com/agent-setup.md. Ask me for my Orchard domain first.
Browse clients

Pick your client

Select a client to get its setup instructions.

Claude Code

  1. Add the server:

    claude mcp add --transport http orchard https://mcp.your-orchard-domain/
  2. Run /mcp in Claude Code. Sign in to Orchard and approve the connection.

  3. To share the server with a project, add .mcp.json instead:

    .mcp.json
    {
      "mcpServers": {
        "orchard": {
          "type": "http",
          "url": "https://mcp.your-orchard-domain/"
        }
      }
    }

Find your MCP URL

Replace your-orchard-domain in the examples with your domain. To get the exact URL, select Account settings > MCP from the account menu.

https://mcp.your-orchard-domain/

Limit what an agent can do

Add parameters to the server URL. They can only lower what a connection gets.

Read-only tools
https://mcp.your-orchard-domain/?scope=read
No exec_in_pod
https://mcp.your-orchard-domain/?scope=deploy
Selected toolsets
https://mcp.your-orchard-domain/?toolsets=databases,domains
The whole API in three tools
https://mcp.your-orchard-domain/compact

MCP for agentsCode mode for agentsMCP tools

Example prompts

Paste these into a connected agent. Each prompt names the tools it uses.

Deploy a repository

Requires a linked GitHub account.

Deploy https://github.com/owner/repo to Orchard. Check access with list_github_deploy_targets, deploy with deploy_from_github_url, then wait on get_deployment_rollout and give me the URL.

Find out why an app is failing

Read-only. Works with ?scope=read.

The api app is failing. Call diagnose_deployment, then read get_deployment_logs and get_killed_container_logs. Tell me the cause. Do not change anything.

Create a database

Stores the connection string as a secret variable.

Create a Postgres database named app-db with create_database. Get its connection string with get_database_connection, then add it to the api app as a secret DATABASE_URL with add_env_vars.

Roll back a bad deploy

Asks before it changes anything.

The latest release of the api app is failing. List recent releases with list_releases. Ask me before you run rollback_to_previous, then confirm with get_deployment_rollout.

Check app resources

Read-only. Works with ?scope=read.

Check whether the api app has the right CPU and memory. Use get_resource_recommendation and get_deployment_metrics. Do not change anything.

Check a domain

Run this before you create an ingress.

Run validate_dns for app.example.com and tell me which records to create.