Expand contributing guide#103
Conversation
There was a problem hiding this comment.
Pull request overview
Expands the contributor documentation for unch by adding a codebase/project map, describing core flows (CLI, indexing, search, embeddings, MCP/Codex, remote indexing), and providing practical guidance on common change points and local test commands. It also updates public-facing docs to reflect the preferred Codex MCP setup via the npm wrapper and refreshes the security support window.
Changes:
- Replace the minimal CONTRIBUTING note with a full project map, core flow explanations, and contributor checklists/test commands.
- Update README + Mintlify + npm wrapper docs to document MCP usage primarily through Codex (
unch codex install). - Update
SECURITY.mdsupported stable line fromv0.3.xtov0.4.x.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
CONTRIBUTING.md |
Major expansion: project map, core flows, common change points, local setup + checks. |
README.md |
Updates MCP section to “MCP for Codex” with npm/Codex install flow and tool descriptions. |
mintlify/commands/mcp.mdx |
Reframes MCP docs around Codex setup/usage and describes what Codex runs. |
mintlify/commands.mdx |
Updates the “Typical MCP flow” section to Codex-focused install instructions. |
npm/unch/README.md |
Updates MCP documentation to emphasize unch codex install and unch-mcp launcher behavior. |
SECURITY.md |
Updates supported stable release line to v0.4.x and trims trailing whitespace. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `search_code` to search indexed code symbols before opening many files | ||
| - `index_repository` to build or refresh the index when needed | ||
|
|
||
| Codex starts the stdio server for you with `unch start mcp`; you normally do not need to run that command by hand. |
There was a problem hiding this comment.
This sentence implies Codex starts the MCP server by running unch start mcp, but the Codex registration uses the unch-mcp launcher command (which then runs unch start mcp). Consider rewording to mention unch-mcp explicitly so users can find the right command when troubleshooting.
| Codex starts the stdio server for you with `unch start mcp`; you normally do not need to run that command by hand. | |
| Codex starts the stdio server for you via the registered `unch-mcp` launcher, which runs `unch start mcp` under the hood; you normally do not need to run either command by hand. |
| ## How to use it | ||
|
|
||
| The server uses: | ||
| After restarting Codex, work in a repository and ask codebase questions normally. The installed skill tells Codex to call unch before broad file reads when semantic code search can help. | ||
|
|
||
| - root: current working directory | ||
| - state dir: `<root>/.semsearch` | ||
| - provider/model: the same defaults as the CLI | ||
| Codex starts the stdio MCP server for you. You normally do not need to run `unch start mcp` by hand. | ||
|
|
There was a problem hiding this comment.
This page used to document unch start mcp [flags] usage and the available flags, but that content was removed while the CLI still supports start mcp flags (e.g. --root, --state-dir, --provider, --model, etc.). Consider adding back at least a short “Run directly / non-Codex clients” section that points readers to unch start mcp --help (or documents the key flags), so Mintlify remains a complete command reference like the index/search pages.
|
@copilot apply changes based on the comments in this thread |
Summary
Tests