docs(miner): cross-reference the MCP tool surface from coding-agent-driver.md - #5418
Conversation
…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 didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-12 18:05:23 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 5 non-blocking
Linked issue satisfactionAddressed Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk 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.
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.
|
Summary
gittensory-miner-mcptool (including the two most recently added,gittensory_miner_get_governor_decisionsandgittensory_miner_status), with the excluded-payload_jsonsafety note for the ledger/governor tools — butdocs/coding-agent-driver.mdhad no pointer to it, and nothing kept the docs and the actual tool registry from silently drifting apart.coding-agent-driver.mdto the README's MCP section.gittensory_*naming convention, different backing store (local SQLite vs. hosted), with a concrete example of a named ORB analog.Test plan
test/unit/miner-mcp-tool-docs-parity.test.ts: extracts everyserver.registerTool("gittensory_miner_...")name straight frombin/gittensory-miner-mcp.jsand 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 fromcoding-agent-driver.mdexists.npm run typecheckpasses.npm run docs:drift-checkpasses.Closes #5162