quick_start is a no-argument, read-only MCP tool. It returns the canonical GitHits guide without querying indexed evidence or changing external state.
The guide covers:
- GitHits scope: public open-source repositories, package artifacts, and public package documentation
- Package, repository, and standalone documentation-site target syntax
- Tool routing for examples, source, docs, package health, vulnerabilities, dependencies, changelogs, and upgrade reviews
- Compact text and JSON output choices
- Cross-tool workflows such as
code_files→code_grep→code_read - External-content safety and evidence citation rules
When agents call it
Plain MCP clients callquick_start once per session before the first GitHits evidence tool, unless the guide is already in context. Every evidence tool remains callable without it.
The packaged githits-mcp skill already embeds the stable guide. An agent that loaded the current skill normally skips quick_start. It calls the tool when the active server exposes experimental tools or when current tool descriptions materially conflict with the installed skill snapshot.
You can request the guide explicitly:
Availability
quick_start is part of the default @githits/mcp tool inventory and the local stdio MCP server. The hosted server must run a compatible @githits/mcp release to expose it.
If a client does not list quick_start, you can still call every other GitHits tool. A current installed githits-mcp skill supplies the same stable guidance.
When you enable the local experimental tools, quick_start adds runtime-specific guidance for resolve_target, code_diff, and any configured issue reporting.
quick_start has no CLI counterpart. Use npx githits@latest --help and the CLI command reference for CLI guidance.