Skip to content

[plan] Document tools scope restrictions in reference docs #8809

@github-actions

Description

@github-actions

Objective

Add documentation explaining which tools are available in included files vs main workflows and the rationale for the restrictions.

Context

The analysis found intentional but undocumented tool restrictions:

  • Main workflows support 13 tools (agentic-workflows, bash, cache-memory, edit, github, playwright, repo-memory, safety-prompt, serena, startup-timeout, timeout, web-fetch, web-search)
  • Included files support only 7 tools (agentic-workflows, bash, cache-memory, github, playwright, repo-memory, serena)
  • Missing in included files: edit, safety-prompt, startup-timeout, timeout, web-fetch, web-search

These are meta-configuration and advanced features, but the restriction is not documented.

Approach

  1. Review docs/src/content/docs/reference/ structure
  2. Locate or create appropriate documentation file for tools configuration
  3. Add section explaining:
    • Full list of tools available in main workflows
    • Subset of tools available in included files
    • Rationale for excluding meta-configuration tools (safety-prompt, timeouts)
    • Rationale for excluding advanced tools (edit, web-fetch, web-search)
    • Examples of tool configuration in each context
  4. Link to individual tool documentation pages

Files to Modify

  • Create or update file in docs/src/content/docs/reference/ directory
  • Possibly update docs/src/content/docs/reference/tools.md if it exists

Acceptance Criteria

  • Documentation lists all available tools by workflow type
  • Clear explanation of why certain tools are excluded from included files
  • Examples demonstrate correct tool usage in both contexts
  • Table or visual aid shows tool availability matrix
  • Documentation linked from getting started or tools overview pages
    Related to [plan] Fix schema consistency issues found in analysis #8804

AI generated by Plan Command for discussion #8801

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions