Skip to content

docs(TSP-1287): document Edit tool button in workforce agent modal#673

Draft
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1287
Draft

docs(TSP-1287): document Edit tool button in workforce agent modal#673
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1287

Conversation

@claude

@claude claude Bot commented Jun 11, 2026

Copy link
Copy Markdown

Summary

  • Adds Managing tools in agent configuration section to agent-to-tool-configuration.mdx documenting the Edit tool button and all available tool actions (edit, disable, duplicate, swap, delete), with a warning callout for shared tools
  • Adds Managing tools in your workforce section to add-tools.mdx with step-by-step access instructions, action descriptions, and an "Editing shared tools" subsection explaining the cloning workflow
  • Updates the Troubleshooting section in agent-to-tool-configuration.mdx to include a "Tool needs modification" entry pointing users to Edit tool
  • Updates Best Practices in add-tools.mdx with tips on using Edit tool contextually and cloning before editing shared tools

Implements documentation for the Edit tool button introduced in PR #15392.

Linear: https://linear.app/relevance/issue/TSP-1287/

Add "Managing tools in agent configuration" and "Managing tools in your
workforce" sections documenting the new Edit tool button alongside other
tool actions (disable, duplicate, swap, delete). Include warning guidance
for shared tools and cross-references to the editing shared tools docs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Jun 11, 2026
@linear

linear Bot commented Jun 11, 2026

Copy link
Copy Markdown

TSP-1287

@mintlify

mintlify Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jun 11, 2026, 3:29 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 3/10 powerful used 3× in add-tools.mdx (lines 29, 43, 93) and once in agent-to-tool-configuration.mdx frontmatter; leverage at agent-to-tool:157. Wrong term "Forced handover" at agent-to-tool:157 (the page uses "Next step" everywhere else). Pervasive title-case headings in both files — 9 violations in add-tools.mdx and 12 in agent-to-tool-configuration.mdx.
🟡 Technical clarity 7/10 "Forced handover" at agent-to-tool:157 contradicts the page's own "Next step" label, which will confuse readers following along in the UI. Absolute URLs in add-tools.mdx:127–129 use a path segment (workforce-features-and-capabilities/...) that doesn't match the repo layout — these links may be stale or broken.
🟡 Non-technical clarity 7/10 Concepts are introduced clearly before instructions begin. The "managing tools" section appearing in both files means a reader following docs sequentially sees the same content twice. Closing paragraphs in both files lean on vague framing ("complex business processes", "sophisticated autonomous workflows") rather than actionable guidance.
🔴 Structure 5/10 "Managing tools in your Workforce" (add-tools.mdx:52–73) duplicates content covered more thoroughly in agent-to-tool-configuration.mdx — one page should be canonical and the other should link to it. Agent-to-tool connection settings appear twice within add-tools.mdx (lines 31–39 and 75–89). "Edge Settings for Tool Connections" (add-tools.mdx:75–89) largely duplicates the dedicated edge-settings.mdx page. Both files end with a conclusion paragraph that restates what was already covered.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment about the whole PR.

Overall vibe: The content is technically accurate and the troubleshooting section in agent-to-tool-configuration.mdx is genuinely useful. The two big problems dragging this down are (1) a systematic heading capitalization issue — virtually every heading in both files uses title case when the standard is sentence case — and (2) significant content duplication, both between the two pages and within add-tools.mdx itself. Fix the headings, kill the banned words, and resolve the duplication, and both pages will be in good shape.

🔧 Issues (31)

Banned words:

  • build/workforces/build-an-ai-workforce/add-tools.mdx:29powerful is banned: "you can create powerful connections"
  • build/workforces/build-an-ai-workforce/add-tools.mdx:43powerful is banned: "One of the most powerful features of the Workforce Builder"
  • build/workforces/build-an-ai-workforce/add-tools.mdx:93powerful is banned: "is what makes the Workforce Builder so powerful"
  • build/workforces/workforce-features/agent-to-tool-configuration.mdx:3powerful is banned in the frontmatter description: "Agent to Tool configuration is a powerful feature"
  • build/workforces/workforce-features/agent-to-tool-configuration.mdx:157leverage is banned: "agents leverage tools appropriately"

Wrong term:

  • build/workforces/workforce-features/agent-to-tool-configuration.mdx:157 — "Forced handover" should be "Next step" — every other reference in this page and in edge-settings.mdx uses "Next step" for this connection type

Incorrect link format:

  • build/workforces/build-an-ai-workforce/add-tools.mdx:127 — absolute URL should be root-relative; also the workforce-features-and-capabilities/workforce-task-view segment looks stale — likely /build/workforces/workforce-features/workforce-task-view
  • build/workforces/build-an-ai-workforce/add-tools.mdx:128 — use root-relative: /build/workforces/build-an-ai-workforce/edge-settings
  • build/workforces/build-an-ai-workforce/add-tools.mdx:129 — use root-relative: /build/workforces/build-an-ai-workforce/add-conditions

Capitalization:

  • build/workforces/build-an-ai-workforce/add-tools.mdx:52workforceWorkforce (product name)

Heading sentence case — add-tools.mdx (9 violations):

  • :7 ## What Are Tools in Workforce?## What are Tools in Workforce?
  • :18 ## How to Add Tools to Your Workforce## How to add Tools to your Workforce
  • :27 ## Connecting Tools in Your Workforce## Connecting Tools in your Workforce
  • :31 ### Agent to Tool Connections### Agent to Tool connections
  • :41 ### Tool to Tool Connections### Tool to Tool connections
  • :75 ## Edge Settings for Tool Connections## Edge Settings for Tool connections
  • :91 ## Tool to Tool Workflows## Tool to Tool workflows
  • :113 ## Best Practices for Tools in Workforce Builder## Best practices for Tools in Workforce Builder
  • :125 ## Related Features## Related features

Heading sentence case — agent-to-tool-configuration.mdx (12 violations):

  • title / sidebarTitle frontmatter: "Agent to Tool Configuration""Agent to Tool configuration"
  • :7 ## Understanding Agent to Tool Connections## Understanding Agent to Tool connections
  • :16 ## Setting Up Agent to Tool Configurations## Setting up Agent to Tool configurations
  • :25 ## Managing tools in agent configuration## Managing tools in Agent configuration ("Agent" is a product name)
  • :47 ## Configuration Options## Configuration options
  • :72 ## Best Practices for Agent to Tool Configuration## Best practices for Agent to Tool configuration
  • :98 ### 3. Workflow Optimization### 3. Workflow optimization
  • :106 ## Troubleshooting Agent to Tool Connections## Troubleshooting Agent to Tool connections
  • :108 ### Common Issues and Solutions### Common issues and solutions
  • :127 ## Advanced Agent to Tool Configurations## Advanced Agent to Tool configurations
  • :129 ### Chaining Multiple Tools### Chaining multiple Tools
  • :139 ### Dynamic Tool Selection### Dynamic Tool selection
  • :149 ## Related Features## Related features
🏗️ Page structure (4)
  • build/workforces/build-an-ai-workforce/add-tools.mdx:31–39 and :75–89 — agent-to-tool connection settings (AI connection, Next step, approval modes) are described twice within the same page. Lines 75–89 are the more complete version; collapse lines 31–39 to a brief intro and point readers to edge-settings.mdx for the full option reference.
  • build/workforces/build-an-ai-workforce/add-tools.mdx:52–73 — the "Managing tools" section duplicates agent-to-tool-configuration.mdx in detail. Pick agent-to-tool-configuration.mdx as canonical; replace this section with a one-sentence summary and a link.
  • build/workforces/build-an-ai-workforce/add-tools.mdx:75–89 — the "Edge Settings for Tool Connections" section restates content already covered in the dedicated edge-settings.mdx page. Replace with a brief summary and a link to /build/workforces/build-an-ai-workforce/edge-settings.
  • build/workforces/build-an-ai-workforce/add-tools.mdx:131 / build/workforces/workforce-features/agent-to-tool-configuration.mdx:155–158 — both pages end with a freestanding conclusion paragraph that adds nothing. Remove or replace with a lean "What's next?" section linking to /build/workforces/build-an-ai-workforce/edge-settings, /build/workforces/workforce-features/agent-to-tool-configuration, and /build/workforces/workforce-features/tool-to-tool-configuration.
⚠️ Contradictions (2)
  • build/workforces/workforce-features/agent-to-tool-configuration.mdx:157 uses "Forced handover" while build/workforces/build-an-ai-workforce/edge-settings.mdx and the rest of agent-to-tool-configuration.mdx call the same connection type "Next step". Align the conclusion to "Next step".
  • build/workforces/workforce-features/agent-to-tool-configuration.mdx:62 lists "Max auto runs" as one of four sub-options under "Approval mode" (alongside Auto run, Approval required, Let agent decide). build/workforces/build-an-ai-workforce/edge-settings.mdx:22–24 treats "Max auto runs" as a separate top-level configuration option distinct from Approval mode. The two pages describe the same setting but with different UI hierarchies — one needs to match the other.
🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~499

Files read: build/workforces/build-an-ai-workforce/add-tools.mdx (130 lines), build/workforces/workforce-features/agent-to-tool-configuration.mdx (157 lines), build/workforces/build-an-ai-workforce/edge-settings.mdx (119 lines), build/workforces/workforce-features/tool-to-tool-configuration.mdx (93 lines)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant