Repository navigation
Commit 5f3a9ba
docs: restructure README and add client setup guide (#82)
* docs: restructure README and add client setup guide
README cut from 707 to ~220 lines. Per-client config blocks, pipeline
internals, and eval harness moved to dedicated docs where they belong.
Screenshots and CLI previews moved up before the setup details.
- docs/client-setup.md: new file with all 7 client configs (stdio + HTTP
where supported), fallback single-project setup, and local build testing
- docs/capabilities.md: add practical routing examples and selection_required
response shape (moved from README)
- CONTRIBUTING.md: add eval harness section (moved from README)
- templates/mcp/stdio/.mcp.json + http/.mcp.json: copy-pasteable config templates
- tests/mcp-client-templates.test.ts: regression tests for template validity
and README/capabilities doc coverage
- package.json: add docs/client-setup.md to files array
* Update tests/mcp-client-templates.test.ts
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
---------
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>1 parent c637bf5 commit 5f3a9ba
8 files changed
Lines changed: 530 additions & 494 deletions
File tree
- docs
- templates/mcp
- http
- stdio
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
71 | 90 | | |
72 | 91 | | |
73 | 92 | | |
| |||
0 commit comments