Expand stdio command help text with examples, log behavior, and usage guidance#1551
Conversation
…ror behavior Co-authored-by: waldekmastykarz <11164679+waldekmastykarz@users.noreply.github.com>
Co-authored-by: waldekmastykarz <11164679+waldekmastykarz@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
This PR enhances the stdio command help text by adding comprehensive documentation about what the command does, how it works, and practical usage examples. The stdio command is critical for agent integration (especially with MCP servers), and the previous help text was minimal. This change makes the command much more discoverable and usable.
Changes:
- Added detailed multi-line description explaining stdio proxying behavior, log file handling, and error output
- Added three practical examples: MCP server proxy, Node.js app proxy, and custom config usage
- Updated both
StdioCommand.cs(actual command) andDevProxyConfigOptions.cs(early parsing) to maintain consistency
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| DevProxy/Commands/StdioCommand.cs | Expanded command description from single-line to multi-paragraph with examples, log behavior documentation, and usage guidance |
| DevProxy/Commands/DevProxyConfigOptions.cs | Applied identical help text updates to maintain consistency with the actual StdioCommand implementation |
garrytrinder
left a comment
There was a problem hiding this comment.
Tested: builds clean. Stdio help expanded with description, examples, log file behavior, stderr documentation. Consistent with DevProxyConfigOptions. LGTM.
StdioCommanddescription with detailed explanation of what the command doesdevproxy-stdio-YYYYMMDD-HHmmss.log, not console)DevProxyConfigOptions.csfor consistencyOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.