Skip to content

docs: technical reference and bilingual parity update for Agent tools#791

Merged
yacosta738 merged 1 commit into
mainfrom
docs/scribe-tools-parity-update-7970044883575128246
May 6, 2026
Merged

docs: technical reference and bilingual parity update for Agent tools#791
yacosta738 merged 1 commit into
mainfrom
docs/scribe-tools-parity-update-7970044883575128246

Conversation

@yacosta738
Copy link
Copy Markdown
Contributor

This PR provides a comprehensive update to the Corvus Agent tools documentation to ensure 100% accuracy and bilingual parity.

Key improvements:

  • Parameter Tables: Added detailed parameter tables (name, type, description) for all Hardware, Task, Cron, and WebFetch tools, derived directly from their Rust JSON schemas.
  • Task Management: Replaced the brief "parity boundary" note with a full API reference for the persistent task lifecycle tools (TaskCreate, TaskGet, TaskList, TaskUpdate, TaskStop).
  • Technical Accuracy: Verified all security tiers and platform support against the current agent-runtime implementation.
  • Bilingual Parity: Fully synchronized all English and Spanish versions, maintaining the repository's strict 1:1 documentation rule.
  • Validation: Updated lastReviewed metadata and confirmed that both make docs-check and make docs-build pass successfully.

This update ensures that developers and users have the precise technical information required to interact with the Corvus toolset.


PR created automatically by Jules for task 7970044883575128246 started by @yacosta738

- Updated `hardware.md` (en/es) with detailed parameter tables for all hardware tools.
- Expanded `core.md` (en/es) task parity section into full API definitions for `TaskCreate`, `TaskGet`, `TaskList`, `TaskUpdate`, and `TaskStop`.
- Added parameter reference for `WebFetch` in `web.md` (en/es).
- Added parameter reference for `cron_runs` and `cron_update` in `automation.md` (en/es).
- Synchronized `lastReviewed` dates and improved category summaries in `index.mdx` (en/es).
- Fixed typo in CLI reference update command description.
- Verified bilingual parity and metadata validation across all 10 modified files.

All changes verified against `agent-runtime` Rust implementation and validated with `make docs-check` and `make docs-build`.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 6, 2026

Deploying corvus with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1b3bee5
Status: ✅  Deploy successful!
Preview URL: https://d8faed4c.corvus-42x.pages.dev
Branch Preview URL: https://docs-scribe-tools-parity-upd.corvus-42x.pages.dev

View logs

@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: fb4f3155-aee1-4543-ba7e-6c6986e97a81

📥 Commits

Reviewing files that changed from the base of the PR and between cfb9b3d and 1b3bee5.

📒 Files selected for processing (12)
  • clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/automation.md
  • clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/core.md
  • clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/hardware.md
  • clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/index.mdx
  • clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/web.md
  • clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/automation.md
  • clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/core.md
  • clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/hardware.md
  • clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/index.mdx
  • clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/web.md
  • clients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
  • clients/web/apps/docs/src/content/docs/guides/cli-reference.md

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Enhanced agent runtime tools documentation with detailed parameter specifications across automation, core, hardware, and web tools
    • Reorganized task management documentation to clarify persistent runtime task operations and lifecycle
    • Expanded hardware tool documentation with comprehensive specifications for board info, capabilities, memory operations, and GPIO/Arduino control
    • Updated tool category index to reflect all newly documented capabilities

Walkthrough

Documentation files for agent runtime tools are updated across English and Spanish versions. Changes include metadata date bumps, restructured task management documentation with explicit parameter sections, expanded hardware tools documentation with detailed parameter tables, and updated tool references in indexes.

Changes

Agent Runtime Tools Documentation

Layer / File(s) Summary
Metadata Updates
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/*.md, clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/*.md, clients/web/apps/docs/src/content/docs/guides/cli-reference.md, clients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
lastReviewed date updated from 2026-03-26 to 2026-05-06 across all files.
Task Management Documentation
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/core.md, clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/core.md
"Task management parity" section replaces "Task parity boundary" section, introducing five persistent task tools (TaskCreate, TaskGet, TaskList, TaskUpdate, TaskStop) with descriptions, security tiers, compatibility aliases, and parameter tables.
Automation Tools Documentation
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/automation.md, clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/automation.md
Cron tools documentation expanded: cron_runs and cron_update now have explicit parameter sections (job_id, limit for cron_runs; job_id, patch for cron_update), replacing prior concise descriptions.
Hardware Tools Documentation
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/hardware.md, clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/hardware.md
Comprehensive parameter tables added for hardware tools: hardware_board_info, hardware_capabilities, hardware_memory_map, hardware_memory_read, gpio_read, gpio_write, and arduino_upload now include security tiers, supported platforms/boards, and detailed parameter definitions.
Web Tools Documentation
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/web.md, clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/web.md
WebFetch documentation restructured: removed Contract and Scope boundary sections; added compatibility alias (web_fetch) and native relationship note; introduced Parameters subsection defining url and prompt as required inputs.
Documentation Index Updates
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/index.mdx, clients/web/apps/docs/src/content/docs/es/clients/agent-runtime/tools/index.mdx
Core Tools category updated to include persistent task reference (TaskCreate); Hardware Tools category expanded to include arduino_upload.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

  • dallay/corvus#399: Modifies the same documentation files (core.md, index.mdx) with overlapping content changes.
  • dallay/corvus#397: Both PRs expand agent-runtime Tools documentation with parameter sections and tool references across English and Spanish files.
  • dallay/corvus#457: Updates same tool documentation areas (automation cron entries, hardware tools, tools index) with extended tool references.

Suggested labels

area:docs, area:web

Suggested reviewers

  • yuniel-acosta
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/scribe-tools-parity-update-7970044883575128246

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Microsoft Presidio Analyzer (2.2.362)
clients/web/apps/docs/src/content/docs/clients/agent-runtime/tools/automation.md

Microsoft Presidio Analyzer failed to scan this file

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the size/m Denotes a medium change size label May 6, 2026
@yacosta738 yacosta738 requested a review from yuniel-acosta May 6, 2026 14:39
@yuniel-acosta yuniel-acosta marked this pull request as ready for review May 6, 2026 14:40
@yuniel-acosta yuniel-acosta enabled auto-merge May 6, 2026 14:41
@yacosta738 yacosta738 merged commit 3938044 into main May 6, 2026
15 of 17 checks passed
@yacosta738 yacosta738 deleted the docs/scribe-tools-parity-update-7970044883575128246 branch May 6, 2026 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs area:web size/m Denotes a medium change size

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants