docs: add concrete usage examples for all 24 tools - #213
Open
TerminalGravity wants to merge 4 commits into
Open
Conversation
- 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
Adds a new 'Usage Examples' section to README with real-world invocations organized by workflow: everyday preflight, planning, clarifying vague prompts, sub-agent enrichment, history search, session management, analysis/scoring, verification, learning from mistakes, and multi-task sequencing.
TerminalGravity
commented
Mar 11, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
24 tools with examples — this is going to be a huge help for discoverability. People shouldn't have to read source code to understand what each tool does. LGTM.
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.
The Tool Reference section lists all 24 tools but doesn't show how to actually use them. This adds a Usage Examples section with real-world invocations organized by workflow:
Every example uses real parameter names and realistic values.