Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
85 lines (61 loc) · 3.14 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

85 lines (61 loc) · 3.14 KB
Raw

Change Type

  • Add a new server definition
  • Update an existing server definition
  • Fix a bug in an existing definition
  • Other (describe in Summary)

Summary

Server Details

  • Server Name:
  • Server ID: community.example or com.publisher-name
  • Transport: stdio / http
  • Authentication: none / api_key / optional_api_key / oauth / basic
  • Categories:
  • Upstream Repository: https://github.com/...

Checklist

CI-enforced — your PR will fail without these

  • JSON file lives at servers/<id>.json
  • Filename matches the id field exactly
  • Required fields present: id, name, transport
  • pnpm validate servers/<id>.json passes
  • pnpm check-conflicts passes (no duplicate IDs or aliases)
  • pnpm test passes
  • Every commit is signed off — git commit -s (DCO)

Reviewer quality bar

  • description is one clear sentence — no marketing fluff
  • At least one category from categories.json is assigned
  • Every ${input:ID} placeholder has a matching metadata.inputs[].id
  • Every secret / credential input is marked "secret": true
  • Each credential input has an obtain block with step-by-step instructions (numbered, \n between steps)
  • auth.type is consistent with how credentials are actually wired into the transport
  • links.repository resolves (when the upstream is public)
  • capabilities (tools / resources / prompts / read_only_mode) reflect what the server actually implements
  • platforms is accurate — don't claim ["all"] without verifying Windows/macOS/Linux

Platform-managed fields — leave unset

  • I did not set badges, stats, sponsored, featured
  • I did not set publisher.official, publisher.verified, publisher.domain_verified
  • I did not add any _platform*-prefixed keys

Trademark & branding

  • No "official" / "certified" / "endorsed" wording unless I represent the trademark owner
  • I have the right to reference the icon URL (emoji or an asset I'm allowed to hot-link)

Tested locally (recommended for new servers)

  • Installed the server in McpMux and it started successfully
  • Called at least one tool / fetched at least one resource / rendered at least one prompt

Notes for Reviewers