docs(MCP_STANDARDS): make portable — strip Bear-specific rules#124
Merged
Conversation
The 'Mutation Response Metadata' section named Bear tools, referenced Bear-specific helpers (`getNoteContent()`, post-create polling), and explained Bear's fire-and-forget URL architecture as the rationale for the 'never read after write' rule. That's project-specific content in a doc whose stated purpose was generic MCP design conventions. Replace it with a portable 'Mutation Response Conventions' principle: 1. Confirm the write landed (what-changed or version token). 2. Address the affected resource (stable identifier). 3. Reason about freshness for subsequent writes (version token where the underlying system exposes one — HTTP ETag, Core Data Z_OPT, document revision, etc.). Plus a field-sourcing discipline paragraph that generalizes the 'never read after write' rule: prefer pre-write values; if a post-write read is unavoidable, design it to wait for a *change* (write-confirmation) and surface a clearly-labelled sentinel on timeout rather than a possibly-stale value. The doc now stays free of Bear-specific tool names, column names, and helper functions so the rules can be lifted into a future MCP project as-is. The project-specific instantiation belongs in SPECIFICATION.md (landing as part of a follow-up PR — see end of MCP_STANDARDS for the pointer). Update CLAUDE.md's dev-doc index entry to match.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Owner
Author
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
There was a problem hiding this comment.
Pull request overview
Doc-only refactor that generalizes docs/dev/MCP_STANDARDS.md from Bear-specific guidance into portable MCP server conventions, deferring project-specific instantiation to SPECIFICATION.md.
Changes:
- Rewrites "Mutation Response Metadata" as a portable "Mutation Response Conventions" principle (confirm write, stable identifier, version token).
- Generalizes the "never read after write" rule into a field-sourcing discipline paragraph with sentinel-on-timeout guidance.
- Updates the
CLAUDE.mdindex entry forMCP_STANDARDS.mdto reflect the new portable framing.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/dev/MCP_STANDARDS.md | Replaces Bear-specific mutation response rules with generic MCP conventions and a portable field-sourcing principle. |
| CLAUDE.md | Updates the dev-doc index line to match the new portable framing. |
Per PR review feedback: 'Not generic — a project convention, a standard.' The previous wording overclaimed portability. MCP_STANDARDS is not a portable framework that could be lifted into a future MCP project as-is — it's THIS project's standards for how we design our MCP server's tool surface. Reframe accordingly: - Drop 'Generic conventions ... portable: apply to any MCP server, not just this one'. - Drop the trailing 'so the rules can be lifted into a future MCP project as-is'. - Keep the original cleanup intent: the doc still deliberately excludes specific tool names, DB columns, and helper functions, because those belong with the implementations they describe (SPECIFICATION.md, BEAR_DATABASE_SCHEMA.md) — not as a portability mechanism, but as a separation-of-concerns mechanism that keeps the conventions easy to apply consistently. Update CLAUDE.md's dev-doc index entry to match.
|
| Global tag mutations (`bear-rename-tag`, `bear-delete-tag`) are not note-level and intentionally omit note metadata. | ||
|
|
||
| Never fetch tags or other metadata from the database after a write — Bear's fire-and-forget architecture means post-write reads return pre-mutation state, which would mislead the LLM into thinking the operation failed. | ||
| Tools are first discovered via descriptions, then invoked via schemas. Optimize both for the AI agent and the LLM, not for humans. |
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.
No description provided.