You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .agents/skills/githits-release/SKILL.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,9 @@ Use this skill for GitHits changelog maintenance, release work, version-bump PRs
61
61
## Agent Skills Lifecycle
62
62
63
63
- User-facing skills under `skills/` are picked up by `skills.sh` from `main`, not from npm release artifacts.
64
-
- Do not update `skills/` to describe unreleased CLI/MCP behavior. A merge to `main` can expose those skill instructions immediately.
64
+
- Do not update `skills/` to describe unreleased CLI/MCP behavior, except for the bounded `githits-mcp` stable-guide rule below. A merge to `main` can expose those skill instructions immediately.
65
+
- For the `githits-mcp` stable guide, exact parity is a bounded exception: when backing stable behavior or `buildMcpQuickStart()` changes, update the backing behavior, builder, and embedded terminal guide copy in the same PR, merge that PR to `main`, and ship it in the next applicable release cycle. This accepts the bounded main-to-release window for `skills.sh`; it does not create a deploy-first or two-PR flow. `buildLocalMcpQuickStart()` runtime appendices remain excluded from the public copy.
66
+
-`githits-onboarding` keeps its separate release-branch rule: update the public skill only on the release branch after the corresponding CLI behavior is included, so `skills.sh` does not advertise unreleased onboarding behavior.
65
67
- After the backing CLI/MCP behavior is released or part of the release being prepared, update `skills/` so skill descriptions, decision flows, examples, detailed references, and command-to-MCP mappings match the released surface.
66
68
- When MCP instructions, tool descriptions, or guardrails change, review `skills/githits-code/SKILL.md`, `skills/githits-package/SKILL.md`, and their references for parity. Keep MCP instructions as the quality baseline; they are currently strong and should not be weakened casually.
67
69
- After changing public skills or plugin-facing guidance, run `bun run plugins:generate` and `bun run plugins:check` so every host manifest remains aligned with the canonical root surface.
Copy file name to clipboardExpand all lines: AGENTS.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,6 +82,7 @@ See `docs/guidelines/TESTING.md` for comprehensive patterns.
82
82
- Root `skills/` and `AGENTS.md` are the only authored shared agent guidance. `CLAUDE.md` and `GEMINI.md` must remain symlinks to `AGENTS.md`.
83
83
- Use the repository-internal `githits-plugin-maintenance` skill when changing skills, agent guidance, plugin/marketplace/extension manifests, MCP transport metadata, root release metadata, generator behavior, or agent-facing setup/auth behavior. It must remain under `.agents/skills/` and must not be published with the public root `skills/` tree.
84
84
- Do not edit generated plugin assets directly. Change their canonical inputs, run `bun run plugins:generate`, inspect the diff, and run `bun run plugins:check`.
85
+
-`packages/mcp/src/mcp/instructions.ts` owns the stable `buildMcpQuickStart()` guide. When it or the terminal guide section in `skills/githits-mcp/SKILL.md` changes, update both in the same PR; `src/skills-packaging.test.ts` exact-parity coverage is the contract. `buildLocalMcpQuickStart()` runtime appendices are excluded from the public skill copy. Behavior-dependent guide changes follow the public Agent Skill lifecycle.
85
86
-`server.json` owns the canonical plugin keyword list used by generated manifests; keep `package.json` aligned with it.
86
87
- All plugin and extension packages use hosted remote MCP. Direct `githits init` configuration retains local stdio except for Cursor, which is remote-only. Claude and Gemini direct setup remove legacy plugin or extension state before installing the user-scoped stdio server.
-**Self-contained MCP skill** - The loaded `githits-mcp` skill now includes the stable quick-start guidance without a redundant bootstrap call, while plain MCP clients retain the `quick_start` fallback.
Copy file name to clipboardExpand all lines: docs/implementation/tools.md
+25-13Lines changed: 25 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,14 +52,17 @@ Write the prefix as the answer to “why would an agent choose this tool now?”
52
52
53
53
GitHits intentionally omits MCP initialize instructions because clients treat
54
54
them inconsistently: some hide them, some promote them, and some repeat them
55
-
with every tool. The no-argument, read-only `quick_start` tool is the canonical
56
-
shared guide. Its catalog prefix names routing, public-OSS scope, and
57
-
external-content safety; its full description asks agents to call it once per
58
-
session before other GitHits tools unless the quick-start guide is already in
59
-
context. It also states that tools execute without it but then lack the shared
60
-
safety posture. Its result owns public-OSS scope, target syntax, output,
61
-
safety, citations, and cross-tool routing. Individual tool descriptions remain
62
-
self-contained so direct tool selection does not depend on the bootstrap.
55
+
with every tool. Guidance has two delivery paths: a loaded `githits-mcp` skill
56
+
already carries the stable guide and skips a normal `quick_start` call, while
57
+
plain MCP clients use the no-argument, read-only `quick_start` tool as their
58
+
fallback. Current tool descriptions remain authoritative; a material mismatch
59
+
with a stale skill snapshot or an exposed `Experimental` descriptor can still
60
+
require `quick_start` for runtime-specific guidance. The stable guide is owned
61
+
by `packages/mcp/src/mcp/instructions.ts`; the terminal skill section must stay
62
+
byte-for-byte aligned under `src/skills-packaging.test.ts`. Local
63
+
`buildLocalMcpQuickStart()` appendices are runtime-only and excluded from that
64
+
public copy. Individual tool descriptions remain self-contained so direct
65
+
tool selection does not depend on the bootstrap.
63
66
64
67
Use the tools in these roles:
65
68
@@ -97,7 +100,7 @@ Use the tools in these roles:
97
100
98
101
| Tool | Parameters | Description |
99
102
|---|---|---|
100
-
|`quick_start`| none | Load the canonical guide for public GitHub/package search, grep, code, docs, examples, routing, and external-content safety without querying GitHits evidence. Call once per session before other GitHits tools unless the guide is already in context. |
103
+
|`quick_start`| none | Load the canonical guide for public GitHub/package search, grep, code, docs, examples, routing, and external-content safety without querying GitHits evidence. Plain MCP clients call it once per session before other GitHits tools; skip it when the loaded `githits-mcp` skill already carries the guide. |
101
104
|`get_example`|`query`, `language?`, `license_mode?`, `format?`| Find canonical cross-project examples when no single target is the answer or target-scoped search came up short. For a known package or repository, use `search`, `docs_*`, or `code_*`. Defaults to markdown with source provenance and an optional `solution_id` for `feedback`; pass `format: "json"` for `{result, solution_id?}`. |
102
105
|`search_language`|`query`, `format?`| Resolve a supported language name or alias for `get_example`; do not use it for source search. Defaults to one compact line per match; pass `format: "json"` for structured matches. |
103
106
|`feedback`|`solution_id?`, `accepted`, `feedback_text?`, `tool_name?`| Submit feedback when a GitHits result or the overall experience was helpful, unhelpful, wrong, incomplete, slow, or confusing. Pass `solution_id` to rate an example or `tool_name` to identify a result. |
|`packages/core-internal/src/services/githits-service.ts`| REST API client for example search, languages, and feedback |
671
683
|`packages/core-internal/src/services/code-navigation-service.ts`| Package/source service client for unified `search`, `search_status`, `code_files`, `code_read`, and `code_grep`|
0 commit comments