Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to DeployHQ

Scalekit connector
Open markdown

The DeployHQ connector lets your AI agent act in each user's DeployHQ account. Each user connects their own DeployHQ API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
31 · 21 · 831 read21 write8 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the DeployHQ connection

    In AgentKit > Connections, create a DeployHQ connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • deployhq_account_getGet the DeployHQ account: name, permalink, plan and limits.Read-only

    Get Account

    Get the DeployHQ account: name, permalink, plan and limits. Use this to check the connection.

    Inputs

    This tool takes no inputs.

  • deployhq_auto_deployments_listList which servers and groups of a project deploy automatically on push, and the project's webhook URL.Read-only

    List Automatic Deployment Settings

    List which servers and groups of a project deploy automatically on push, and the project's webhook URL.

    Inputs

    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
  • deployhq_build_commands_listList the build pipeline commands of a project, in order.Read-only

    List Build Commands

    List the build pipeline commands of a project, in order.

    Inputs

    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
  • deployhq_config_file_getGet one config file of a project with its contents.Read-only

    Get Config File

    Get one config file of a project with its contents.

    Inputs

    idstringrequired
    Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
  • deployhq_config_files_listList the config files a project uploads on each deployment.Read-only

    List Config Files

    List the config files a project uploads on each deployment.

    Inputs

    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
  • deployhq_deployment_getGet one deployment.Read-only

    Get Deployment

    Get one deployment. Returns its status (pending, running, completed, failed or a preview state), revisions, servers, files changed, steps and timings.

    Inputs

    idstringrequired
    Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
  • deployhq_deployment_step_logs_listList the log entries of one step of a deployment.Read-only

    List Deployment Step Logs

    List the log entries of one step of a deployment. Use this to see why a deployment failed; step identifiers come from deployhq_deployment_get.

    Inputs

    deployment_idstringrequired
    Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
    step_idstringrequired
    Identifier of the deployment step. Example: b2c3d4e5-f6a7-8901-bcde-f12345678901.
    beforeinteger
    Return log entries with an ID below this one, to page back. Example: 1500.
  • deployhq_deployments_listList the deployments of a project, newest first.Read-only

    List Deployments

    List the deployments of a project, newest first. Returns per deployment its identifier, servers, start and end revisions, status, deployer and times. Use deployhq_deployment_get for its steps.

    Inputs

    project_idstringrequired
    Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
    currently_runningstring
    Set to 1 to list only running deployments. Example: 1.one of 1
    pageinteger
    Page number, starting at 1. Example: 2.
    per_pageinteger
    Deployments per page (default 10). Example: 25.
    tostring
    Only deployments to this server or server group identifier. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.