Skip to content

Commit 39fed35

Browse files
Remove manual scope-to-tools table from docs
The README already has auto-generated tool documentation with scopes. Keep only the scope hierarchy explanation which is structural.
1 parent 8afb4fb commit 39fed35

File tree

1 file changed

+2
-30
lines changed

1 file changed

+2
-30
lines changed

docs/scope-filtering.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,7 @@ Example output:
3434
x-oauth-scopes: delete_repo, gist, read:org, repo
3535
```
3636

37-
## Scopes and Tools
38-
39-
The following table shows which OAuth scopes are required for each category of tools:
40-
41-
| Scope | Tools Enabled |
42-
|-------|---------------|
43-
| `repo` | Repository operations, issues, PRs, commits, branches, code search, workflows |
44-
| `public_repo` | Star/unstar public repositories (implicit with `repo`) |
45-
| `read:org` | Read organization info, list teams, team members |
46-
| `write:org` | Organization management (includes `read:org`) |
47-
| `admin:org` | Full organization administration (includes `write:org`, `read:org`) |
48-
| `gist` | Create, update, and manage gists |
49-
| `notifications` | List, manage, and dismiss notifications |
50-
| `read:project` | Read GitHub Projects |
51-
| `project` | Create and manage GitHub Projects (includes `read:project`) |
52-
| `security_events` | Code scanning, Dependabot, secret scanning alerts (implicit with `repo`) |
53-
| `user` | Update user profile |
54-
| `read:user` | Read user profile information |
55-
56-
### Scope Hierarchy
37+
## Scope Hierarchy
5738

5839
Some scopes implicitly include others:
5940

@@ -63,16 +44,7 @@ Some scopes implicitly include others:
6344

6445
This means if your token has `repo`, tools requiring `security_events` will also be available.
6546

66-
## Recommended Token Scopes
67-
68-
For full functionality, we recommend these scopes:
69-
70-
| Use Case | Recommended Scopes |
71-
|----------|-------------------|
72-
| Basic development | `repo`, `read:org` |
73-
| Full development | `repo`, `admin:org`, `gist`, `notifications`, `project` |
74-
| Read-only access | `repo` (with `--read-only` flag) |
75-
| Security analysis | `repo` (includes `security_events`) |
47+
Each tool in the [README](../README.md#tools) lists its required and accepted OAuth scopes.
7648

7749
## Graceful Degradation
7850

0 commit comments

Comments
 (0)