docs: add concrete usage examples for key tools - #121
Merged
Conversation
TerminalGravity
commented
Mar 5, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
Love the direction. Real input/output examples are the #1 thing people look for when evaluating a tool. 415 additions is a lot of README though — have you considered putting these in a separate docs/examples.md and linking from the README? Keeps the main README scannable while still having the depth.
Either way, this is a big DX improvement. 👍
TerminalGravity
force-pushed
the
docs/usage-examples
branch
from
March 7, 2026 05:21
814b247 to
b07063a
Compare
- examples/.preflight/config.yml — profile, related projects, thresholds, embeddings - examples/.preflight/triage.yml — keyword rules and strictness tuning - examples/.preflight/contracts/api.yml — manual cross-service contract definitions - examples/README.md — quick setup instructions - README.md — link to examples from config reference section
…MCP server The 'preflight-dev' bin runs the init wizard, not the server. Users following the npm install path had no way to launch the actual MCP server without pointing into node_modules (which the init script was doing incorrectly, referencing 'preflight' instead of 'preflight-dev'). - Add bin/serve.js as 'preflight-dev-serve' entry point - Fix init CLI to generate correct .mcp.json using preflight-dev-serve - Update README quickstart to use npx -y preflight-dev-serve
TerminalGravity
force-pushed
the
docs/usage-examples
branch
from
March 11, 2026 16:48
b07063a to
630b8b3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Usage Examples section to the README with real input/output examples for 6 key tools: preflight_check (vague + multi-step), prompt_score, estimate_cost, search_history, and verify_completion. Helps new users understand what the tools actually produce before installing.