Skip to content

feat(docs): Add skill for PR review, AGENTS.md, and contributing guide - #318

Draft
andreyvelich wants to merge 1 commit into
modelcontextprotocol:mainfrom
andreyvelich:review-skill
Draft

andreyvelich wants to merge 1 commit into
modelcontextprotocol:mainfrom
andreyvelich:review-skill

Conversation

@andreyvelich

@andreyvelich andreyvelich commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

I added initial contributing guide, AGENTS.md, and skill for PR reviews.

Motivation and Context

This should enhance how AI agents interact with our code base. Please review the contributing and agents guide for correctness.

/assign @varun06 @jeanmatthieu @akhilcb

How Has This Been Tested?

Breaking Changes

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

This PR was assisted with AI tools.

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
@andreyvelich
andreyvelich requested a review from a team as a code owner October 30, 2026 23:05
@andreyvelich

Copy link
Copy Markdown
Member Author

/hold for review

@andreyvelich
andreyvelich marked this pull request as draft October 30, 2026 23:06
Comment thread AGENTS.md
@@ -0,0 +1,323 @@
# AGENTS.md

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@modelcontextprotocol/swift-sdk Please review this and let me know if you think it would be better to shorten it.

@akhilcb akhilcb 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.

Thanks for putting this together, @andreyvelich. Having AGENTS.md and CONTRIBUTING.md will help a lot and I checked most of the paths, commands and conventions against main. They're accurate. A few suggestions:

AGENTS.md / CONTRIBUTING.md

  • The Agent Behavior Policy links the 2026-07-28 spec, while Principle 2 says the SDK implements up to 2025-11-25. Since 2026-07-28 support is still in progress, a short note on which revision to follow (current behavior vs. new-spec work) would help agents avoid mixing the two.
  • .vscode/settings.json has formatOnSave turned on, so the "no formatter configuration" line could say something like "don't commit unrelated formatting changes" instead.
  • NetworkTransport uses [weak self] in a few NWConnection callbacks. Narrowing that rule to actor-owned Tasks might stop agents from "fixing" working code.
  • The Base/ imports rule could be "match the file you're editing", since some Base/ files use import Foundation.
  • A one-line CLAUDE.md with @AGENTS.md would let Claude Code pick this up automatically.

review-pr skill

  • For /review-pr <PR_LINK>, it might help to fetch the PR diff (gh pr diff) explicitly. Right now the agents default to the local git diff.
  • Could code-simplifier be advisory-only in this flow, so it doesn't edit the local checkout during a review?
  • Some of the agent prompts still have references from other languages and projects (Go/Rust/Python, errorIds.ts/Sentry, pkg/foo/bar.go). Swapping those for our MCPError and swift-log conventions would make the prompts sharper.
  • The publish-guard hook could also catch gh api with -f/-F/--input, since those default to POST. If the hook is meant as a personal opt-in, .claude/settings.local.json might be a better place to register it than the shared settings file.

Really like the pending-review and suggestion-block approach. Thanks again!

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