Skip to content

docs: clarify messaging vs full tool profiles#39954

Merged
vincentkoc merged 3 commits into
openclaw:mainfrom
posigit:docs/tool-profile-clarity
Apr 27, 2026
Merged

docs: clarify messaging vs full tool profiles#39954
vincentkoc merged 3 commits into
openclaw:mainfrom
posigit:docs/tool-profile-clarity

Conversation

@posigit

@posigit posigit commented Mar 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarify tools.profile behavior in the tools docs, especially the practical difference between messaging and full.

Why

A messaging-first setup can feel unexpectedly restricted when tools.profile is set to messaging, even though the behavior is intentional. This update makes that clearer and points users who want broader command/control capability toward full.

Changes

  • expand the profile descriptions
  • explicitly note that messaging intentionally restricts broader tools
  • add guidance for when full is the better fit
  • add a simple profile: "full" example

Testing

Docs-only change

@openclaw-barnacle openclaw-barnacle Bot added docs Improvements or additions to documentation size: XS labels Mar 8, 2026
@greptile-apps

greptile-apps Bot commented Mar 8, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR improves the tools.profile documentation by expanding terse one-liners into guidance-oriented descriptions, adding a <Note> callout that explains why messaging is intentionally narrow, and providing an explicit profile: "full" example. The changes fit naturally into the existing docs structure and add useful signposting for users surprised by the limited tool surface of a messaging-first setup.

Key observations:

  • Per-profile descriptions are accurate and consistent with the tool-groups inventory later in the file.
  • The messaging profile description correctly lists restricted tool categories (filesystem, runtime, browser, canvas, nodes, cron, gateway), using "such as" to appropriately signal the list is non-exhaustive.
  • The <Note> callout uses valid Mintlify markup and provides correct guidance (profile: "full" for broader access).
  • The new profile: "full" example is technically correct; full is documented as "no restriction (same as unset)".
  • Minor style note: The <Note> block mixes reference styles—opening with the full dotted path tools.profile but then shortening to profile: "messaging" and profile: "full". Normalizing all three to the full path would improve consistency with how the rest of the document refers to config paths.

Confidence Score: 5/5

  • Docs-only change with no runtime impact; all factual claims verified as accurate.
  • This is a docs-only change to a single markdown file with no code alterations. Every factual claim in the new content is verifiable against the existing tool-groups inventory in the same file. The only finding is a minor style consistency issue (mixing reference path formats in one sentence), which has no functional impact. The documentation improvements meaningfully enhance discoverability for users experiencing the intentional restrictions of the messaging profile.
  • No files require special attention.

Last reviewed commit: e53dcf5

Comment thread docs/tools/index.md Outdated
@openclaw-barnacle

Copy link
Copy Markdown

This pull request has been automatically marked as stale due to inactivity.
Please add updates or it will be closed.

@openclaw-barnacle openclaw-barnacle Bot added the stale Marked as stale due to inactivity label Apr 25, 2026
@clawsweeper

clawsweeper Bot commented Apr 26, 2026

Copy link
Copy Markdown
Contributor

Codex automated review: keeping this open.

Keep PR #39954 open. Current main still documents tools.profile as a mechanical profile table and does not include the PR's user-facing clarification that tools.profile: "messaging" is intentionally narrow, nor the direct tools.profile: "full" example for broader command/control access.

Best possible solution:

Keep the PR open and port its useful wording into the current docs/tools/index.md profile section: a compact note that tools.profile: "messaging" is intentionally narrow, tools.profile: "full" is the unrestricted baseline for broader command/control, and a small full-profile example reconciled with the current profile table.

What I checked:

Remaining risk / open question:

Codex Review notes: model gpt-5.5, reasoning high; reviewed against e672b61417af.

@openclaw-barnacle openclaw-barnacle Bot removed the stale Marked as stale due to inactivity label Apr 26, 2026
@vincentkoc

Copy link
Copy Markdown
Member

ProjectClownfish pushed a narrow repair to this branch so the original contributor path can stay canonical.

Source PR: #39954
Validation: pnpm check:changed
Contributor credit is preserved in the branch history and PR context.

@vincentkoc
vincentkoc force-pushed the docs/tool-profile-clarity branch from 2360874 to 998deba Compare April 27, 2026 22:41
@openclaw-barnacle openclaw-barnacle Bot added the scripts Repository scripts label Apr 27, 2026
@vincentkoc
vincentkoc merged commit c51e315 into openclaw:main Apr 27, 2026
65 of 66 checks passed
@vincentkoc vincentkoc added the clawsweeper Tracked by ClawSweeper automation label Apr 27, 2026
ogt-redknie pushed a commit to ogt-redknie/OPENX that referenced this pull request May 2, 2026
* docs: clarify messaging vs full tool profiles

* docs: normalize tools.profile references

* docs: clarify messaging and full tool profiles

---------

Co-authored-by: vincentkoc <[email protected]>
github-actions Bot pushed a commit to Desicool/openclaw that referenced this pull request May 9, 2026
* docs: clarify messaging vs full tool profiles

* docs: normalize tools.profile references

* docs: clarify messaging and full tool profiles

---------

Co-authored-by: vincentkoc <[email protected]>
globalcaos pushed a commit to globalcaos/tinkerclaw that referenced this pull request May 13, 2026
* docs: clarify messaging vs full tool profiles

* docs: normalize tools.profile references

* docs: clarify messaging and full tool profiles

---------

Co-authored-by: vincentkoc <[email protected]>
github-actions Bot pushed a commit to Desicool/openclaw that referenced this pull request May 24, 2026
* docs: clarify messaging vs full tool profiles

* docs: normalize tools.profile references

* docs: clarify messaging and full tool profiles

---------

Co-authored-by: vincentkoc <[email protected]>
jameslcowan pushed a commit to jameslcowan/openclaw that referenced this pull request Jun 2, 2026
* docs: clarify messaging vs full tool profiles

* docs: normalize tools.profile references

* docs: clarify messaging and full tool profiles

---------

Co-authored-by: vincentkoc <[email protected]>
sablehead pushed a commit to sablehead/openclaw that referenced this pull request Jun 10, 2026
* docs: clarify messaging vs full tool profiles

* docs: normalize tools.profile references

* docs: clarify messaging and full tool profiles

---------

Co-authored-by: vincentkoc <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clawsweeper Tracked by ClawSweeper automation docs Improvements or additions to documentation scripts Repository scripts size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants