Skip to content

Commit 5f49351

Browse files
authored
Merge pull request #210 from makeplane/chore-agent_apis_scopes
[SILO-995] chore: add missing scope docs for agent runs
2 parents e2acb08 + 6c2da12 commit 5f49351

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/dev-tools/agents/building-an-agent.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ To create an agent, you first need to [register an OAuth application](/dev-tools
4242
- **Redirect URIs**: Where Plane sends the authorization code after consent
4343
- **Webhook URL Endpoint**: Your service's webhook endpoint for receiving events
4444
4. **Enable the "Enable App Mentions" checkbox** — This is required for agents
45-
5. Save and securely store your **Client ID** and **Client Secret**
45+
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.
46+
6. Save and securely store your **Client ID** and **Client Secret**
4647

4748
::: info
4849
The "Enable App Mentions" checkbox is what transforms a regular OAuth app into an agent that can be @mentioned in work items.

docs/dev-tools/build-plane-app/oauth-scopes.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,12 @@ This document lists all OAuth scopes available when building a Plane app. Reques
122122
| Scope | Description |
123123
|-------|-------------|
124124
| `profile:read` | Read user profile |
125+
126+
## Agent Run scopes
127+
128+
| Scope | Description |
129+
|-------|-------------|
130+
| `agent_runs:read` | Read agent runs |
131+
| `agent_runs:write` | Create and update agent runs |
132+
| `agent_runs.activities:read` | Read agent run activities |
133+
| `agent_runs.activities:write` | Create and update agent run activities |

0 commit comments

Comments
 (0)