This is the “team” page for Agents, intended to be read by internal teammates working on agents.

For user installation docs, see Sourcegraph Agents (EAP).

Background

We announced “AI Agents” on January 29th as part of our Sourcegraph 6.0 release

https://sourcegraph.com/blog/introducing-enterprise-ai-agents

The scope of this Notion page is to aggregate various internal docs on Agents in one place.

Exploratory notes

Quinn wrote the following notes during the early phases of Agents

Agent API notes

Running Agents locally

First, read the customer-facing installation docs Sourcegraph Agents (EAP). This section describes the additional steps you need to make the installed GitHub App work with your locally running https://sourcegraph.test:3443 instance.

• Run sg start minimal-sveltekit like normal.
• Make sure you have completed the customer-facing installation steps. Most importantly, enable the feature flags:
  • agents-eap : boolean with value true
  • agents-auto-review : rollout with 100%
• Follow these instructions to create an ngrok account and tunnel a static domain to your locally running Sourcegraph instance. In short, create an ngrok account and run the following commands (note the --host-header=rewrite flag):

brew install ngrok
ngrok config add-authtoken YOUR_NGROK_TOKEN
ngrok http --url=YOUR_DOMAIN.ngrok-free.app --host-header=rewrite <https://sourcegraph.test:3443>

• Next, update your site configuration externalURL setting (https://sourcegraph.test:3443/site-admin/configuration) to use your ngrok domain.

• We are going to install the GitHub app for your personal account so we need at least one repo on your local instance that is installed with your app. To solve this problem, add a private personal repo to your local instance via ../dev-private/enterprise/dev/external-services-config.json in dev-private. Update the GitHub token to a PTA (gh auth token). Confirm that the Sourcegraph instance has access to this repo by visiting the URL (example: https://sourcegraph.test:3443/github.com/sanjayesn/test-sg-review-agent).

  "token": <YOUR_GH_TOKEN>, // user: sourcegraph-bot-devx token: dev-private-public-only
  "repos": [
    "sourcegraph/sourcegraph",
    ## Add your repo here
    "sanjayesn/test-sg-review-agent",
    ...
  ]
  
  

• Now, it’s time to create an agent. It’s important that you do this through the ngrok URL and not https://sourcegraph.test:3443 because the URL of your browser tab determines the redirect URL for the GitHub App installation. Once you have completed installing the app, you should be redirected to your agent page and you can now close your ngrok URL and use sourcegraph.test:3443 from now on.

<aside> ⚠️

The externalURL setting resets regularly to sourcegraph.test:3443. You will have to update site-admin site config every time you create a new app.

</aside>