From 6c2da1258cf6cb40d8a74960fed7af5a1baf8917 Mon Sep 17 00:00:00 2001 From: Saurabhkmr98 Date: Thu, 19 Feb 2026 14:54:58 +0530 Subject: [PATCH] add missing scope docs for agent runs --- docs/dev-tools/agents/building-an-agent.md | 3 ++- docs/dev-tools/build-plane-app/oauth-scopes.md | 9 +++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/dev-tools/agents/building-an-agent.md b/docs/dev-tools/agents/building-an-agent.md index 60338bb..0dc3a74 100644 --- a/docs/dev-tools/agents/building-an-agent.md +++ b/docs/dev-tools/agents/building-an-agent.md @@ -42,7 +42,8 @@ To create an agent, you first need to [register an OAuth application](/dev-tools - **Redirect URIs**: Where Plane sends the authorization code after consent - **Webhook URL Endpoint**: Your service's webhook endpoint for receiving events 4. **Enable the "Enable App Mentions" checkbox** — This is required for agents -5. Save and securely store your **Client ID** and **Client Secret** +5. **Choose the "Agent Run" scopes** — This is required for agents to be able to create run activities and get run details. See [OAuth Scopes](/dev-tools/build-plane-app/oauth-scopes#agent-run-scopes) for more information on the available scopes. +6. Save and securely store your **Client ID** and **Client Secret** ::: info The "Enable App Mentions" checkbox is what transforms a regular OAuth app into an agent that can be @mentioned in work items. diff --git a/docs/dev-tools/build-plane-app/oauth-scopes.md b/docs/dev-tools/build-plane-app/oauth-scopes.md index f12a44d..77ce90d 100644 --- a/docs/dev-tools/build-plane-app/oauth-scopes.md +++ b/docs/dev-tools/build-plane-app/oauth-scopes.md @@ -122,3 +122,12 @@ This document lists all OAuth scopes available when building a Plane app. Reques | Scope | Description | |-------|-------------| | `profile:read` | Read user profile | + +## Agent Run scopes + +| Scope | Description | +|-------|-------------| +| `agent_runs:read` | Read agent runs | +| `agent_runs:write` | Create and update agent runs | +| `agent_runs.activities:read` | Read agent run activities | +| `agent_runs.activities:write` | Create and update agent run activities | \ No newline at end of file