Skip to content

docs: strengthen coding-standards compliance guardrails - #848

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/mcp-server-coding-standards-0a47
Draft

docs: strengthen coding-standards compliance guardrails#848
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/mcp-server-coding-standards-0a47

Conversation

@cursor

@cursor cursor Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Description

Audited the codebase against docs/coding-standards.md (the canonical registry-driven MCP architecture rules). All 79 pnpm standards:check tests and 3090 unit tests pass on current main.

This PR adds two small guardrails to prevent documentation drift from the enforced model:

  • README Development section now documents pnpm standards:check alongside other dev commands
  • docs-consistency.test.ts now verifies registerTool() wording (not deprecated server.tool()) and that CONTRIBUTING.md cross-references coding standards

Type of Change

  • Documentation

Checklist

  • pnpm test passes (3090 tests)
  • pnpm typecheck passes
  • pnpm build passes
  • pnpm standards:check passes (79 tests)
  • pnpm docs:check not 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 is docs/coding-standards.md + AGENTS.md:

Rule Status
11 consolidated tools (harness_schema included) ✅ Enforced
Pure-data toolsets (no HarnessClient/Registry/logger) ✅ Enforced
Shared response extractors ✅ Enforced (legacy inline extractors grandfathered)
Scope injection via registry ✅ Enforced
identifierFields + operationPolicy on endpoints ✅ Enforced
Error handling (errorResult / toMcpError) ✅ Enforced
No console.log() in src/ ✅ Enforced
Zod v4 + .describe() on tool params ✅ Enforced
Write confirmation via elicitation ✅ Enforced
Singleton HarnessClient ✅ Enforced
CI runs pnpm standards:check on every PR .github/workflows/ci.yml
Open in Web View Automation 

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>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants