Skip to content

Publish MCP Bundles to the official MCP Registry on release - #334

Open
salmanfarisvp wants to merge 3 commits into
masterfrom
mcp-registry-publish
Open

salmanfarisvp wants to merge 3 commits into
masterfrom
mcp-registry-publish

Conversation

@salmanfarisvp

Copy link
Copy Markdown
Member

What

Lists the Screenly MCP server in the official MCP Registry, which GitHub's MCP directory (github.com/mcp) reads from. Part of Screenly/hq#41.

  • mcpb/server.json: registry metadata (name io.github.Screenly/screenly, description, repo, docs URL). Version and packages are placeholders, filled in per release.
  • .github/workflows/mcp-registry.yml: a reusable workflow that, for a given tag:
    1. downloads the release's screenly-macos-arm64.mcpb, screenly-macos-x64.mcpb and screenly-windows-x64.mcpb
    2. writes server.json with the tag's version and each bundle's SHA-256
    3. downloads mcp-publisher (pinned to v1.8.9, Sigstore-verified), then validates, logs in with GitHub OIDC, and publishes
  • release.yml: new publish-mcp-registry job that calls it after build-release, so every tagged release updates the listing.

Why OIDC

The registry only lets org Owners publish under io.github.Screenly/* from a personal login. OIDC from this repo is the registry's recommended route for org namespaces. It needs no stored secret, and only grants id-token: write to this one job.

Testing

  • Ran the "Build server.json" step locally against v26.9.0. The output passes the registry's 2025-12-11 JSON schema, and the hashes match GitHub's asset digests.
  • A non-semver tag (v26.9) fails fast with a clear message.
  • yamllint is clean on both workflows.

After merge

Run Actions → Publish to MCP Registry → Run workflow with tag v26.9.0 (or wait for the v26.11.0 release from #333). Then check:

curl "https://registry.modelcontextprotocol.io/v0/servers?search=io.github.Screenly/screenly"

Notes

  • The registry is in preview, and its docs warn about possible data resets. Re-running the workflow restores the entry.
  • Publishing the same version twice is rejected by the registry, so a manual re-run for an already-published tag will fail. That's expected.
  • If the registry treats the namespace case-sensitively and expects io.github.screenly, the publish step will fail with a permission error. Renaming name in mcpb/server.json fixes it.

Adds a reusable workflow that builds server.json for a release tag
(version plus the SHA-256 of each .mcpb asset) and publishes it to
registry.modelcontextprotocol.io using GitHub OIDC, so no secret or
org Owner login is needed for the io.github.Screenly namespace.

release.yml calls it after build-release; it can also be run by hand
from the Actions tab to publish an existing tag.
Copilot AI lite review requested due to automatic review settings November 19, 2026 08:32
- Skip prerelease tags; only stable vX.Y.Z versions are published
- Run after build-release even if an unrelated matrix leg failed; the
  job fails loudly if a .mcpb asset is missing
- Read server.json metadata from the release tag when it exists
- Per-tag concurrency group so queued runs don't cancel each other
- Pin actions/checkout to a commit SHA in the id-token job
- Download all bundles in a single gh release download call

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The publish workflow has a critical active issue: an attacker able to trigger a release tag could alter the metadata name and use the repository’s OIDC identity to overwrite another registry entry.

1 open issue
What changed in this PR

Adds automated publication of Screenly’s MCP bundles to the official MCP Registry for tagged releases, with support for manually publishing existing releases.

Changes:

  • Adds registry metadata identifying the Screenly MCP server.
  • Introduces a reusable workflow that downloads release bundles, computes SHA-256 hashes, validates metadata, verifies mcp-publisher, authenticates with GitHub OIDC, and publishes to the registry.
  • Integrates registry publication into the release workflow after successful bundle creation.
File Description
mcpb/​server.json Defines the Screenly MCP Registry metadata, including its identity, description, repository, documentation URL, and release-time placeholders.
.github/​workflows/​release.yml Invokes the MCP Registry publication workflow after the release artifacts are built.
.github/​workflows/​mcp-registry.yml Builds release-specific package metadata, verifies the publisher binary, authenticates with OIDC, and publishes the MCP bundles.

Review effort: Lite

Comment thread .github/workflows/mcp-registry.yml Resolved
Copilot AI lite review requested due to automatic review settings November 19, 2026 08:35
Addresses Copilot review: fail before OIDC login if server.json's name
or repository.url differs from the fixed values, so an edited file
can't publish over another io.github.Screenly/* entry.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

A critical unresolved issue allows manually dispatched workflows from unprotected branches to obtain an OIDC token with registry publish permissions and publish arbitrary metadata.

2 open issues

Review effort: Lite

Comment on lines +19 to +24
workflow_dispatch:
inputs:
tag:
description: "Existing release tag to publish, e.g. v26.11.0"
required: true
type: string
Copilot AI lite review requested due to automatic review settings November 19, 2026 08:38
@salmanfarisvp

Copy link
Copy Markdown
Member Author

Status: ready, holding until the hosted MCP server is live

This PR is reviewed and tested. We're holding the merge, so that our first MCP Registry listing is one people can use by pasting a URL, not just the CLI bundles.

Why wait

  • We don't have a remote MCP server yet. Listed now, the entry would only offer the .mcpb bundles. Users would still install a bundle and paste an API token, the same as today.
  • Few registry clients install .mcpb packages.
  • The registry can't record which bundle is for which OS or CPU, so a client could pick the wrong one (for example macOS arm64 on an Intel Mac).

Plan

  1. When https://mcp.screenly.io/mcp (Phase 1 in Screenly/hq#41) is live, add a remotes entry to mcpb/server.json:
    "remotes": [{ "type": "streamable-http", "url": "https://mcp.screenly.io/mcp" }]
  2. Merge, then publish with Actions → Publish to MCP Registry → Run workflow, or with the next release tag.

Review changes since opening

  • Only stable vX.Y.Z tags publish; prereleases are skipped.
  • Publishing runs even if an unrelated matrix leg fails, and fails loudly if a bundle is missing.
  • Metadata is read from the release tag when it exists.
  • Each tag gets its own concurrency group.
  • actions/checkout is pinned to a SHA.
  • The workflow refuses to publish any name other than io.github.Screenly/screenly, or any repository other than Screenly/cli. This addresses the Copilot comment.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Critical authorization flaws in both publishing workflows allow repository writers to use mutable or unauthorized runs to obtain OIDC credentials and publish or overwrite registry entries.

1 open issue
1 previously missed issue

In code that hasn't changed since last review

High severity Authorize release tags before granting registry credentials

.github/​workflows/​release.yml:169

This grants the registry OIDC credential to any run that reaches this reusable workflow, but the workflow never establishes that TAG is an authorized release: a repository writer who can push a stable vX.Y.Z tag (or run the dispatch workflow for an unpublished release) can publish a new package and overwrite the io.github.Screenly/screenly listing. The name/repository check only limits which entry is targeted; it does not protect the release contents. Gate this job with protected release-tag rules and/or a protected environment/approval, and apply the same authorization to manual dispatch before exposing id-token: write.

1 resolved since last review

Review effort: Lite

This branch has not been deployed

No deployments
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