Documentation Index
Fetch the complete documentation index at: https://docs.githits.com/llms.txt
Use this file to discover all available pages before exploring further.
Some agent harnesses call MCP tools aggressively. Others wait until you ask for a specific kind of research. If your agent is guessing, looping, or relying on generic knowledge, tell it directly to use GitHits.
For a broader view of when to use GitHits during planning, implementation, and debugging, see Use GitHits in agentic coding workflows.
Prompt patterns
Use these prompts inside your coding agent.
Find a real implementation pattern
Use GitHits Code Examples to find a real open-source implementation of <task or API>. Use the result to guide this change and cite the source you used.
Good for unfamiliar APIs, integration patterns, and current ecosystem conventions.
Debug a dependency issue
Use GitHits Code Navigation to inspect <package_name> version that we have in use. Search for <symbol, behavior, or error message>, then read the relevant source lines and debug the issue.
Good when a stack trace points into a dependency, docs do not explain a behavior, or the agent keeps guessing. The agent can usually infer the package version from your repo.
Read package documentation
Use GitHits docs tools for <package_name> and find the documentation page about <topic>. Summarize the relevant section before implementing.
Good when hosted docs or repo-backed docs are needed inside the agent session.
Review a package or upgrade
Use GitHits Package Inspection for <package_name>. Check vulnerabilities, dependencies, and relevant changelog entries for the version change in this repo.
Good for dependency triage, vulnerability checks, and upgrade context.
Agent instruction snippet
Add this to your project instructions if you want stronger default behavior:
When work depends on open-source libraries, use GitHits before guessing. Use Code Examples for current real-world implementation patterns, Code Navigation to inspect dependency source for the version in this repo, Documentation Access for hosted or repo-backed docs, and Package Inspection for dependency metadata, vulnerabilities, and changelogs.