Skip to content

Commit ad1f32b

Browse files
docs: unbloat tools reference (#61238)
1 parent 5b77198 commit ad1f32b

1 file changed

Lines changed: 12 additions & 37 deletions

File tree

‎docs/src/content/docs/reference/tools.md‎

Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -40,34 +40,28 @@ See **[GitHub Tools Reference](/gh-aw/reference/github-tools/)** for complete co
4040

4141
### Linear Tools (`linear:`)
4242

43-
Connect to [Linear's official hosted MCP server](https://linear.app/docs/mcp) using the well-known `LINEAR_API_KEY` GitHub Actions secret:
43+
Connect to [Linear's official hosted MCP server](https://linear.app/docs/mcp) with the `LINEAR_API_KEY` GitHub Actions secret:
4444

4545
```yaml wrap
4646
tools:
4747
linear: {}
4848
```
4949

50-
Set `token` to use a different secret containing a Linear API key or OAuth access token. The integration uses Streamable HTTP through the MCP gateway and always uses Linear's server-enforced read-only endpoint. Use `allowed` to restrict tool names and `required: false` to make Linear connectivity best-effort:
50+
Set `token` to use a different secret, `toolsets` to enable groups such as `issues` and `projects`, `allowed` to further restrict tool names, and `required: false` to make connectivity best-effort:
5151

5252
```yaml wrap
5353
tools:
5454
linear:
5555
token: ${{ secrets.CUSTOM_LINEAR_TOKEN }}
56+
toolsets: [issues, projects]
5657
allowed: ["*"]
5758
required: true
5859
```
5960

60-
Use `toolsets` to enable related groups of tools without maintaining individual tool names:
61-
62-
```yaml wrap
63-
tools:
64-
linear:
65-
toolsets: [issues, projects]
66-
```
61+
Supported toolsets are `all`, `attachments`, `comments`, `customers`, `cycles`, `diffs`, `documentation`, `documents`, `initiatives`, `issues`, `milestones`, `projects`, `status_updates`, `teams`, and `users`. The compiler expands toolsets into the gateway's allowed-tool list, and any `allowed` names or wildcards must match a tool in the selected toolsets.
6762

68-
Supported toolsets are `all`, `attachments`, `comments`, `customers`, `cycles`, `diffs`, `documentation`, `documents`, `initiatives`, `issues`, `milestones`, `projects`, `status_updates`, `teams`, and `users`. The compiler expands toolsets into the gateway's allowed-tool list. If `allowed` is also set, each name or wildcard must match a tool in the selected toolsets.
63+
Linear always uses Linear's server-enforced read-only endpoint. The credential is passed to the gateway as an environment variable and sent as an `Authorization: Bearer` header, not embedded in MCP configuration. Like other remote MCP servers, Linear also works with `tools.cli-proxy: true`.
6964

70-
The Linear credential is passed to the gateway as an environment variable and sent as an `Authorization: Bearer` header. It is not embedded in MCP configuration. Linear works with `tools.cli-proxy: true` like other remote MCP servers.
7165
### Jira Tools (`jira:`)
7266

7367
Connect to Atlassian's official remote Rovo MCP endpoint from non-interactive GitHub Actions workloads. Browser OAuth, device login, and user-consent flows are not supported.
@@ -99,19 +93,9 @@ tools:
9993
- searchJiraIssuesUsingJql
10094
```
10195

102-
The `allowed` list is required and accepts only these read-only Jira tools:
103-
104-
- `getIssueLinkTypes`
105-
- `getJiraIssue`
106-
- `getJiraIssueRemoteIssueLinks`
107-
- `getJiraIssueTypeMetaWithFields`
108-
- `getJiraProjectIssueTypesMetadata`
109-
- `getTransitionsForJiraIssue`
110-
- `getVisibleJiraProjects`
111-
- `lookupJiraAccountId`
112-
- `searchJiraIssuesUsingJql`
96+
The `allowed` list is required and accepts only these read-only Jira tools: `getIssueLinkTypes`, `getJiraIssue`, `getJiraIssueRemoteIssueLinks`, `getJiraIssueTypeMetaWithFields`, `getJiraProjectIssueTypesMetadata`, `getTransitionsForJiraIssue`, `getVisibleJiraProjects`, `lookupJiraAccountId`, and `searchJiraIssuesUsingJql`.
11397

114-
`allowed: ["*"]` is also accepted as shorthand for enabling all nine tools above; it is expanded to that fixed list at compile time and never grants access to the full, unrestricted MCP tool set. Omitting `allowed` or naming a write-capable tool is rejected.
98+
`allowed: ["*"]` is shorthand for enabling that fixed list at compile time; it never grants access to the full, unrestricted MCP tool set. Omitting `allowed` or naming a write-capable tool is rejected.
11599

116100
The endpoint defaults to `https://mcp.atlassian.com/v1/mcp`. Set `url` only when your organization uses another HTTPS Atlassian MCP endpoint. Credentials must be direct GitHub Actions secret expressions; service account keys use the HTTP bearer scheme while API tokens use HTTP Basic authentication generated at runtime.
117101

@@ -214,29 +198,25 @@ See [GH-AW as an MCP Server](/gh-aw/reference/gh-aw-as-mcp-server/) for availabl
214198

215199
### MCP CLI Mounting (`cli-proxy:`)
216200

217-
Set `tools.cli-proxy: true` to mount each user-facing MCP server as a standalone CLI tool on `PATH`. When enabled, the agent can invoke MCP servers as shell commands rather than through the MCP protocol:
201+
Set `tools.cli-proxy: true` to mount each user-facing MCP server as a standalone CLI tool on `PATH`, so the agent can invoke it from shell instead of through the MCP protocol:
218202

219203
```yaml wrap
220204
tools:
221205
cli-proxy: true
222206
```
223207

224-
With CLI mounting enabled, MCP servers accessible to the workflow (such as `safeoutputs` and `mcpscripts`) are wrapped as executable commands. For example:
208+
With CLI mounting enabled, workflow-accessible servers such as `safeoutputs` and `mcpscripts` are wrapped as executables:
225209

226210
```bash
227211
safeoutputs add_comment --item_number 42 --body "Analysis complete"
228212
mcpscripts mcpscripts-gh --args "issue list --limit 5"
229213
```
230214

231-
The safe-output `add_comment` tool uses `--item_number` (not `--issue_number`) to target the issue or pull request — passing `--issue_number` is silently stripped by schema validation.
232-
233-
The MCP gateway configuration is unchanged — servers still start as normal. Only the agent's view changes: servers registered for CLI mounting are removed from the MCP tool list and accessed via shell instead.
234-
235-
This reduces token consumption from large MCP tool schemas and can simplify workflow prompts when shell-style invocation is preferred.
215+
For `add_comment`, use `--item_number` rather than `--issue_number`; schema validation strips the latter. CLI mounting changes only the agent-facing interface: the MCP gateway still starts normally, but mounted servers are removed from the MCP tool list and accessed via shell. This can reduce token use from large tool schemas and simplify prompts when shell-style invocation is preferred.
236216

237217
Defaults to `false`.
238218

239-
CLI mounting requires shell access: the wrappers are ordinary executables invoked from bash. GitHub `gh-proxy` mode is also shell-backed because GitHub reads are performed with the `gh` CLI. When `tools.bash` is disabled (`bash: false` or `bash: []`), `cli-proxy: true` and `tools.github.mode: gh-proxy` are rejected at compile time, and strict mode requires `cli-proxy: false` to be stated explicitly:
219+
CLI mounting requires shell access because the wrappers are ordinary executables invoked from bash. GitHub `gh-proxy` mode is also shell-backed because GitHub reads are performed with the `gh` CLI. When `tools.bash` is disabled (`bash: false` or `bash: []`), `cli-proxy: true` and `tools.github.mode: gh-proxy` are rejected at compile time, and strict mode requires `cli-proxy: false` to be stated explicitly:
240220

241221
```yaml wrap
242222
tools:
@@ -323,9 +303,4 @@ mcp-servers:
323303

324304
## Learn More
325305

326-
- [GitHub Tools](/gh-aw/reference/github-tools/) - GitHub API operations, toolsets, and modes
327-
- [Playwright](/gh-aw/reference/playwright/) - Browser automation and testing configuration
328-
- [Cache Memory](/gh-aw/reference/cache-memory/) - Persistent memory across workflow runs
329-
- [Repo Memory](/gh-aw/reference/repo-memory/) - Repository-specific memory storage
330-
- [MCP Scripts](/gh-aw/reference/mcp-scripts/) - Define custom inline tools with JavaScript or shell scripts
331-
- [MCPs](/gh-aw/guides/mcps/) - Complete Model Context Protocol setup and usage
306+
See [GitHub Tools](/gh-aw/reference/github-tools/) for GitHub API operations, toolsets, and modes; [Playwright](/gh-aw/reference/playwright/) for browser automation; [Cache Memory](/gh-aw/reference/cache-memory/) and [Repo Memory](/gh-aw/reference/repo-memory/) for persistent context; [MCP Scripts](/gh-aw/reference/mcp-scripts/) for custom inline tools; and [MCPs](/gh-aw/guides/mcps/) for end-to-end Model Context Protocol setup.

0 commit comments

Comments
 (0)