docs: strengthen coding-standards compliance guardrails - #848
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
Add README Development mention of pnpm standards:check and extend docs-consistency tests to lock registerTool() wording and CONTRIBUTING cross-references against drift from the 11-tool Zod v4 registry model. Co-authored-by: Rohan Gupta <thisrohangupta@users.noreply.github.com>
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Audited the codebase against
docs/coding-standards.md(the canonical registry-driven MCP architecture rules). All 79pnpm standards:checktests and 3090 unit tests pass on currentmain.This PR adds two small guardrails to prevent documentation drift from the enforced model:
pnpm standards:checkalongside other dev commandsdocs-consistency.test.tsnow verifiesregisterTool()wording (not deprecatedserver.tool()) and thatCONTRIBUTING.mdcross-references coding standardsType of Change
Checklist
pnpm testpasses (3090 tests)pnpm typecheckpassespnpm buildpassespnpm standards:checkpasses (79 tests)pnpm docs:checknot required (no registry count changes)Coding Standards Review Summary
The pasted automation snapshot references 10 tools, Zod v3, and
server.tool()— all outdated. The authoritative source isdocs/coding-standards.md+AGENTS.md:harness_schemaincluded)identifierFields+operationPolicyon endpointserrorResult/toMcpError)console.log()insrc/.describe()on tool paramsHarnessClientpnpm standards:checkon every PR.github/workflows/ci.yml