Skip to content

docs(miner): cross-reference the MCP tool surface from coding-agent-driver.md - #5418

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
joaovictor91123:feat/miner-mcp-tool-surface-docs-5162
Jul 12, 2026
Merged

docs(miner): cross-reference the MCP tool surface from coding-agent-driver.md#5418
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
joaovictor91123:feat/miner-mcp-tool-surface-docs-5162

Conversation

@joaovictor91123

Copy link
Copy Markdown
Contributor

Summary

  • The miner README's "MCP server" section already documents every landed gittensory-miner-mcp tool (including the two most recently added, gittensory_miner_get_governor_decisions and gittensory_miner_status), with the excluded-payload_json safety note for the ledger/governor tools — but docs/coding-agent-driver.md had no pointer to it, and nothing kept the docs and the actual tool registry from silently drifting apart.
  • Adds a "Related docs" cross-reference from coding-agent-driver.md to the README's MCP section.
  • Strengthens the paragraph relating AMS's local MCP tools to ORB's hosted ones: shared gittensory_* naming convention, different backing store (local SQLite vs. hosted), with a concrete example of a named ORB analog.
  • No source or runtime behavior changes — documentation only.

Test plan

  • New test/unit/miner-mcp-tool-docs-parity.test.ts: extracts every server.registerTool("gittensory_miner_...") name straight from bin/gittensory-miner-mcp.js and asserts the README documents each one and nothing else — so a future tool addition/removal that forgets the docs (or a doc that describes an unlanded tool) fails CI instead of drifting silently. Also asserts the excluded-column safety note and the hosted-vs-local relating paragraph are present, and that the cross-reference from coding-agent-driver.md exists.
  • npm run typecheck passes.
  • npm run docs:drift-check passes.
  • Targeted vitest run of the new/adjacent doc tests passes.

Closes #5162

…river.md

The README's MCP server section already documents every landed
gittensory-miner-mcp tool, including the excluded-columns safety note for
the ledger/governor tools, but nothing pointed a coding-agent-driver.md
reader at it, and there was no automated check keeping the docs in sync
with the actual tool registry. Adds the cross-reference, strengthens the
paragraph relating AMS's local tools to ORB's hosted ones (naming
convention, local SQLite vs. hosted backing store), and adds a parity
test that fails if a registered tool goes undocumented or vice versa.

Closes JSONbored#5162
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

@codecov

codecov Bot commented Jul 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.45%. Comparing base (fd5800f) to head (8d843e9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5418   +/-   ##
=======================================
  Coverage   94.45%   94.45%           
=======================================
  Files         553      553           
  Lines       44357    44357           
  Branches    14659    14659           
=======================================
  Hits        41898    41898           
  Misses       1784     1784           
  Partials      675      675           
Flag Coverage Δ
shard-1 43.91% <ø> (-0.25%) ⬇️
shard-2 34.77% <ø> (+0.02%) ⬆️
shard-3 31.53% <ø> (+0.06%) ⬆️
shard-4 31.44% <ø> (+0.01%) ⬆️
shard-5 32.91% <ø> (-0.39%) ⬇️
shard-6 43.87% <ø> (+0.46%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 12, 2026
@loopover-orb

loopover-orb Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-12 18:05:23 UTC

3 files · 2 AI reviewers · no blockers · readiness 100/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a documentation-only PR that adds a cross-reference from coding-agent-driver.md to the README's MCP section, strengthens the paragraph relating AMS's local MCP tools to ORB's hosted ones, and adds a parity test that pins the README's tool list against the real registerTool() calls in the MCP bin. I verified the regex in registeredMinerMcpToolNames() against the actual bin file content shown and it correctly extracts all 8 gittensory_miner_* tool names; the README documents all of them and the cross-reference anchor (../README.md#mcp-server) matches the actual '## MCP server' heading. The change is small, well-targeted, and closes #5162 as claimed.

Nits — 5 non-blocking
  • The parity test's regex `server\.registerTool\(\s*\n?\s*"(gittensory_miner_\w+)"` only allows zero or one newline between the opening paren and the tool name string — if a future registration is formatted with different whitespace (e.g. two blank lines or a comment line) it would silently fail to match and the test would just see one fewer registered tool rather than erroring, weakening the drift-detection guarantee it's meant to provide.
  • The mcpSection slice in the test (`readme.indexOf("## MCP server")` to `readme.indexOf("## Version check")`) will silently produce an empty or wrong-length string if either heading is ever renamed, rather than failing with a clear message — worth an explicit assertion that both indices are >= 0.
  • Consider asserting `readme.indexOf("## MCP server")` and `readme.indexOf("## Version check")` are both non-negative before slicing, so a heading rename fails loudly instead of producing a misleading empty-section match.
  • The regex could be loosened to tolerate more whitespace/comment variation between `registerTool(` and the tool name, or use a more robust AST-based extraction, to keep the drift guard resilient to formatting changes.
  • nit: `test/unit/miner-mcp-tool-docs-parity.test.ts:23` slices the MCP section using raw `indexOf` results without first asserting both headings exist, so a future heading rename would produce a confusing parity failure instead of a clear section-boundary failure.
Signal Result Evidence
Code review ✅ No blockers 2 reviewers, synthesized
Linked issue ✅ Linked #5162
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low review scope from cached public metadata (1 linked issue).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 132 registered-repo PR(s), 75 merged, 11 issue(s).
Contributor context ✅ Confirmed Gittensor contributor joaovictor91123; Gittensor profile; 132 PR(s), 11 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ⚠️ ℹ️ Insufficient signal risk: clean · value: insufficient-signal — Nothing measurable for the structural-improvement analyzers on this PR (e.g. no code files changed). LLM value judgment: minor — The change is a well-scoped, low-risk documentation fix with a genuinely useful regression test that prevents future doc/registry drift, but it's inherently small in scope (one cross-reference link, one paragraph edit, one test file).
Linked issue satisfaction

Addressed
The diff adds the required coding-agent-driver.md cross-reference to the README's MCP section, strengthens the paragraph relating AMS's local tools to ORB's hosted ones, and adds a parity test that pins README tool names against the actual MCP bin registry to prevent drift, directly satisfying the issue's cross-reference, relating-paragraph, and drift-check requirements.

Review context
  • Author: joaovictor91123
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: not available
  • Official Gittensor activity: 132 PR(s), 11 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Keep the PR focused and include validation evidence before maintainer review.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.
[BETA] Chat with Gittensory

Ask Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @gittensory ask &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat &lt;question&gt; answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @gittensory mention with a real question is routed to the closest matching read-only command automatically -- no exact syntax required.

Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.

  • Re-run Gittensory review

@loopover-orb loopover-orb Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gittensory approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit b440230 into JSONbored:main Jul 12, 2026
16 checks passed
@loopover-orb loopover-orb Bot added gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. and removed gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. labels Jul 12, 2026
@JSONbored JSONbored added gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. and removed gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. labels Jul 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the new gittensory-miner mcp tool surface in the package README and coding-agent-driver docs

2 participants