Skip to content

[SILO-995] chore: add missing scope docs for agent runs #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Saurabhkmr98 merged 1 commit into from
Feb 20, 2026
+11 −1
Merged

[SILO-995] chore: add missing scope docs for agent runs #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/dev-tools/agents/building-an-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/dev-tools/build-plane-app/oauth-scopes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Loading