Skip to content

docs(TSP-1110): add file operations tool step documentation#558

Open
claude[bot] wants to merge 1 commit intomainfrom
docs/TSP-1110
Open

docs(TSP-1110): add file operations tool step documentation#558
claude[bot] wants to merge 1 commit intomainfrom
docs/TSP-1110

Conversation

@claude
Copy link
Copy Markdown

@claude claude bot commented Mar 26, 2026

Summary

  • Creates first-ever documentation for filesystem mount file operations in agents
  • Adds 6 new pages: overview, read file, write file, edit file (primary focus), list files, delete file
  • Updates docs.json navigation to add a "File Operations" group under Tool Steps
  • Adds File Operations section to the Tool Steps index page (tool-steps.mdx)

Pages added

  • Overview: build/tools/tool-steps/file-operations/index.mdx
  • Edit file: build/tools/tool-steps/file-operations/edit-file.mdx
  • Read file: build/tools/tool-steps/file-operations/read-file.mdx
  • Write file: build/tools/tool-steps/file-operations/write-file.mdx
  • List files: build/tools/tool-steps/file-operations/list-files.mdx
  • Delete file: build/tools/tool-steps/file-operations/delete-file.mdx

The Edit file page has the most detail, covering the new EditFile command from PR RelevanceAI/relevance-api-node#13119 — including parameters, safety behavior (fail-safe on missing/ambiguous targets), examples, best practices, and FAQs.

Test plan

  • Verify all 6 pages render correctly in Mintlify preview
  • Verify navigation group "File Operations" appears under Tool Steps in sidebar
  • Check all internal links resolve (especially cross-references between edit-file and write-file)
  • Confirm no broken anchor links

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

Generated with Claude Code

Creates comprehensive documentation for filesystem mount file operations
(read_file, write_file, edit_file, list_files, delete_file) with primary
focus on the new EditFile command. Includes overview page, individual
operation pages, and navigation updates.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude bot added the docs-drafter Documentation drafted by Claude label Mar 26, 2026
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 26, 2026

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Mar 26, 2026, 6:47 AM

@linear
Copy link
Copy Markdown

linear bot commented Mar 26, 2026

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.

0 participants