harald/cratedocs-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add output formatting as a cli option

Browse source
This commit is contained in:
Danielle Jenkins 2025-03-13 11:34:20 +09:00
parent f50ac58a24
commit 704c7333b6
3 changed files with 170 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -38,16 +38,32 @@ cargo run --bin cratedocs http --address 0.0.0.0:3000
cargo run --bin cratedocs http --debug
```
### Legacy Commands
### Directly Testing Documentation Tools
For backward compatibility, you can still use the original binaries:
You can directly test the documentation tools from the command line without starting a server:
```bash
# STDIN/STDOUT Mode
cargo run --bin stdio-server
# Get help for the test command
cargo run --bin cratedocs test --tool help
# HTTP/SSE Mode
cargo run --bin axum-docs
# Look up crate documentation
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio
# Look up item documentation
cargo run --bin cratedocs test --tool lookup_item --crate-name tokio --item-path sync::mpsc::Sender
# Look up documentation for a specific version
cargo run --bin cratedocs test --tool lookup_item --crate-name serde --item-path Serialize --version 1.0.147
# Search for crates
cargo run --bin cratedocs test --tool search_crates --query logger --limit 5
# Output in different formats (markdown, text, json)
cargo run --bin cratedocs test --tool search_crates --query logger --format json
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio --format text
# Save output to a file
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio --output tokio-docs.md
```
By default, the HTTP server will listen on `http://127.0.0.1:8080/sse`.
@ -127,4 +143,4 @@ This server implements the Model Context Protocol (MCP) which allows it to be ea
## License
MIT License
MIT License