Add missing README.md files for crates + vale lint fixes#2
Conversation
Co-authored-by: bkataru <14833123+bkataru@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive README documentation for six workspace crates (thulp-core, thulp-adapter, thulp-browser, thulp-cli, thulp-guidance, thulp-registry) and updates version references in the thulp-mcp README from 0.1 to 0.2. All READMEs follow a consistent structure with installation instructions, usage examples, and licensing information.
Changes:
- Created README.md files for 6 previously undocumented crates
- Updated thulp-mcp README to reference version 0.2 instead of 0.1
- Added comprehensive code examples, feature descriptions, and API documentation
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/thulp-registry/README.md | New README documenting async thread-safe tool registry API |
| crates/thulp-mcp/README.md | Updated version references from 0.1 to 0.2 |
| crates/thulp-guidance/README.md | New README documenting prompt template system |
| crates/thulp-core/README.md | New README documenting core types and traits |
| crates/thulp-cli/README.md | New README documenting CLI commands and usage |
| crates/thulp-browser/README.md | New README documenting web scraping and browser automation |
| crates/thulp-adapter/README.md | New README documenting OpenAPI to Thulp conversion |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
crates/thulp-cli/README.md
Outdated
| thulp tools validate read_file --args '{"path": "/etc/hosts"}' | ||
|
|
||
| # JSON output for scripting | ||
| thulp tools validate read_file --args '{}' --output json |
There was a problem hiding this comment.
The CLI uses positional arguments, not flags, for tool validation. The correct usage should be thulp tools validate read_file '{"path": "/etc/hosts"}' without the --args flag. The arguments parameter is defined as a positional argument in the CLI code (line 86-87 in main.rs), not as a flag.
| thulp tools validate read_file --args '{"path": "/etc/hosts"}' | |
| # JSON output for scripting | |
| thulp tools validate read_file --args '{}' --output json | |
| thulp tools validate read_file '{"path": "/etc/hosts"}' | |
| # JSON output for scripting | |
| thulp tools validate read_file '{}' --output json |
crates/thulp-cli/README.md
Outdated
| # Validate with JSON arguments | ||
| thulp tools validate read_file --args '{"path": "/etc/hosts"}' | ||
|
|
||
| # JSON output for scripting | ||
| thulp tools validate read_file --args '{}' --output json |
There was a problem hiding this comment.
The CLI uses positional arguments, not flags, for tool validation. The correct usage should be thulp tools validate read_file '{}' without the --args flag. The arguments parameter is defined as a positional argument in the CLI code (line 86-87 in main.rs), not as a flag.
| # Validate with JSON arguments | |
| thulp tools validate read_file --args '{"path": "/etc/hosts"}' | |
| # JSON output for scripting | |
| thulp tools validate read_file --args '{}' --output json | |
| # Validate with JSON arguments (positional arguments parameter) | |
| thulp tools validate read_file '{"path": "/etc/hosts"}' | |
| # JSON output for scripting | |
| thulp tools validate read_file '{}' --output json |
crates/thulp-cli/README.md
Outdated
| thulp mcp list | ||
|
|
||
| # Call MCP tool | ||
| thulp mcp call search --args '{"query": "test"}' |
There was a problem hiding this comment.
The CLI uses positional arguments, not flags, for MCP tool calls. The correct usage should be thulp mcp call search '{"query": "test"}' without the --args flag. The arguments parameter is defined as a positional argument in the CLI code (line 116-117 in main.rs), not as a flag.
| thulp mcp call search --args '{"query": "test"}' | |
| thulp mcp call search '{"query": "test"}' |
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: bkataru <14833123+bkataru@users.noreply.github.com>
Fixed in da61234. Changed |
thulp-corecratethulp-adaptercratethulp-browsercratethulp-clicratethulp-guidancecratethulp-registrycrate--argsflag fortools validateandmcp callcommandsSummary
All 10 crates in the "crates" folder now have README.md files:
Each README includes installation instructions, usage examples, and license information following the existing documentation pattern.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.