Claude/fix readme long commands v7yt3#379
Claude/fix readme long commands v7yt3#379jbdawinna wants to merge 2 commits intowonderwhy-er:mainfrom
Conversation
The section had a heading and placeholder text but no actual content. Added a concise numbered list covering the key workflow: starting processes, reading output with pagination, sending input, listing sessions, and terminating processes. https://claude.ai/code/session_01P3h7kRs1h8o1QvbTj21xbc
list_sessions only shows active processes, not completed ones. The listCompletedSessions() method exists but is not called by the tool function. https://claude.ai/code/session_01P3h7kRs1h8o1QvbTj21xbc
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
📝 WalkthroughWalkthroughThe README.md has been updated with procedural guidance for managing long-running processes. The documentation introduces a workflow covering process initiation, output reading with pagination, stdin interaction, session listing, and process termination, with the workflow steps repeated in a dedicated section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
codeant-ai
bot
added
the
size:XS
Sequence DiagramThis PR fills the previously empty README section with the core workflow for managing long running commands. It documents the end to end usage of process tools and clarifies that list_sessions returns only active sessions. sequenceDiagram
participant User
participant MCPServer
User->>MCPServer: start_process with short timeout
MCPServer-->>User: Return pid and initial output
User->>MCPServer: read_process_output with pid and paging
MCPServer-->>User: Return new output chunk
User->>MCPServer: interact_with_process with stdin input
MCPServer-->>User: Continue running process session
User->>MCPServer: list_sessions
MCPServer-->>User: Return active sessions only
User->>MCPServer: force_terminate with pid
MCPServer-->>User: Process terminated
Generated by CodeAnt AI |
|
CodeAnt AI finished reviewing your PR. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
764-768: Clear and accurate workflow documentation!The 5-step workflow is well-structured and matches the implementation based on the provided context snippets. The parameter descriptions (offset=0 for last read, negative offset for tail) align with the schema definitions, and the correction that
list_sessionsshows only active processes is properly reflected.Optional enhancement: Add a concrete example
Consider adding a practical example after line 768 to demonstrate the workflow in action:
**Example workflow:** ```javascript // 1. Start a long-running process const result = await start_process({ command: "npm run dev", timeout_ms: 2000 }); const pid = result.pid; // Save the PID // 2. Read output (gets everything since last read) await read_process_output({ pid, offset: 0, length: 50 }); // 3. Send input to the process await interact_with_process({ pid, input: "test\n" }); // 4. Check all active sessions await list_sessions({}); // 5. Terminate when done await force_terminate({ pid });This would make the workflow more concrete for users. </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 764 - 768, Add a short concrete example showing the
5-step workflow using start_process, read_process_output, interact_with_process,
list_sessions, and force_terminate (after the existing steps), demonstrating
capturing the returned pid from start_process, using timeout_ms, reading with
offset=0 and a length, sending stdin via interact_with_process, listing sessions
with list_sessions(), and finally terminating with force_terminate({ pid }) so
readers can see the exact call sequence and parameter usage.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In@README.md:
- Around line 764-768: Add a short concrete example showing the 5-step workflow
using start_process, read_process_output, interact_with_process, list_sessions,
and force_terminate (after the existing steps), demonstrating capturing the
returned pid from start_process, using timeout_ms, reading with offset=0 and a
length, sending stdin via interact_with_process, listing sessions with
list_sessions(), and finally terminating with force_terminate({ pid }) so
readers can see the exact call sequence and parameter usage.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `691b963a-457c-4d8e-a008-90ba3ec037d3` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d854870577c2fd45c5a52670cfcc39b1918d035b and 160d14fd0103e0566fafe77f97dd6e60b58343aa. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
2 participants
User description
Summary
start_process,read_process_output,interact_with_process,list_sessions, andforce_terminateCodeAnt-AI Description
Document handling of long-running commands in README
What Changed
Impact
✅ Clearer README for long-running command workflows✅ Fewer mistakes when reading or interacting with background processes✅ Faster onboarding for integrations that use REPL/SSH-style sessions💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.
Summary by CodeRabbit
Release Notes