chore: add MCP registry publishing #679

gagik · 2025-10-23T12:35:19Z

According to instructions in https://github.com/modelcontextprotocol/registry/blob/main/docs/guides/publishing/publish-server.md

Copilot

Pull Request Overview

This PR adds MCP registry publication support to the MongoDB MCP Server project. It introduces a server.json configuration file for the MCP registry, creates a code generation script to keep environment variable documentation synchronized, and updates the CI/CD pipeline to publish to the registry.

Key Changes:

Added MCP registry configuration file (server.json) with environment variables and package arguments
Created automated script to generate environment variable definitions from Zod schema
Updated publish workflow to include MCP registry publication step

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
server.json	New MCP registry configuration with environment variables and package arguments for npm and OCI packages
src/common/config.ts	Refactored UserConfig to use Zod schema with descriptions, enabling automated documentation generation
scripts/generateArguments.ts	New script to generate and sync environment variable definitions across server.json from config schema
package.json	Added mcpName field and generate:args script for documentation generation
Dockerfile	Added MCP server name label for registry identification
.github/workflows/publish.yml	Updated workflow to generate arguments, install MCP publisher, and publish to registry

scripts/generateArguments.ts

gagik · 2025-10-23T12:38:25Z

.github/workflows/publish.yml

+        run: brew install mcp-publisher
+
+      - name: Login to MCP Registry
+        run: mcp-publisher login github-oidc


I am not too sure if this is going to work but seems worth trying

scripts/generateArguments.ts

gagik · 2025-10-23T12:41:51Z

server.json

@@ -0,0 +1,670 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json",
+  "name": "io.github.mongodb-js/mongodb-mcp-server",


we can either use io.github.mongodb-js and use GitHub Auth or mongodb.com and use DNS auth. the latter depends on a lot of external approvals I imagine so sticking to GitHub

we can also use an auth token, though OIDC publishing will also be great to adopt for NPM in the future: https://github.blog/changelog/2025-07-31-npm-trusted-publishing-with-oidc-is-generally-available/

gagik · 2025-10-23T12:42:35Z

scripts/generateArguments.ts

+/**
+ * This script generates environment variable definitions and updates:
+ * - server.json environmentVariables arrays
+ * - TODO: README.md configuration table


this needed some extra handling but will be great to have in the future.

gagik · 2025-10-23T12:49:18Z

src/common/config.ts

-    vectorSearchDimensions: number;
-    vectorSearchSimilarityFunction: Similarity;
-}
+export const UserConfigSchema = z.object({


I want to turn this into a single source of truth for our arguments. This should be useful in the future, including for runtime validation.

.github/workflows/publish.yml

nirinchev · 2025-10-23T12:43:17Z

src/common/config.ts

+    loggers: z
+        .array(z.enum(["stderr", "disk", "mcp"]))
+        .default(["disk", "mcp"])
+        .describe("Comma separated values, possible values are 'mcp', 'disk' and 'stderr'."),


The description doesn't seem to match the type.

Yeah these are copied over from README.md but the schema were created with (eventual) validation in mind. Definitely a confusing setup the way it is, so will remove all the descriptions for now since I dropped my bonus goal to get this to handle README.md

So... I think for the time being this is fine, this isn't something we're consuming yet and as far as user-facing description and program-facing validation, it still makes sense.
In the future we should adopt https://zod.dev/metadata and have multiple fields to define this. This needs a Zod version bump otherwise I'd use it now

src/common/config.ts

server.json

gagik · 2025-10-23T13:56:27Z

src/common/config.ts

+    httpHeaders: z
+        .record(z.string())
+        .describe(
+            "Custom HTTP headers to include in responses from the HTTP server (only used when transport is 'http'). Useful for adding CORS headers, authentication tokens, or other custom headers required by your client application."


is this accurate? my interpretation of when one would use this @nirinchev

No, these are headers that the http server will validate when making requests. This is e.g. what we do for the auth header by the vscode extension.

nirinchev · 2025-10-23T13:55:03Z

.github/workflows/publish.yml

      RELEASE_CHANNEL: ${{ steps.npm-tag.outputs.RELEASE_CHANNEL }}
    steps:
      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: mongodb-js/devtools-shared/actions/setup-bot-token@main


Is this in the wrong job?

is it? seems to be the way we get the token everywhere

You're adding this to the check job, but seems like you're trying to use it in the publish job. Step outputs cannot be passed across jobs.

.github/workflows/publish.yml

nirinchev · 2025-10-23T13:56:23Z

.github/workflows/publish.yml

        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Update server.json version and arguments


Can we move this at least temporarily as the last step? I expect there may be rough edges in the first couple of runs, so don't want this failing to impact the other steps.

chore: add server.json file the MCP registry

cebb0ba

gagik requested a review from a team as a code owner October 23, 2025 12:35

Copilot AI review requested due to automatic review settings October 23, 2025 12:35

Copilot AI reviewed Oct 23, 2025

View reviewed changes

scripts/generateArguments.ts Outdated Show resolved Hide resolved

scripts/generateArguments.ts Show resolved Hide resolved

gagik changed the title ~~chore: add server.json file the MCP registry~~ chore: add MCP registry publishing Oct 23, 2025

chore: fix name

df96544

gagik commented Oct 23, 2025

View reviewed changes

scripts/generateArguments.ts Outdated Show resolved Hide resolved

gagik marked this pull request as draft October 23, 2025 12:39

gagik added 2 commits October 23, 2025 14:40

chore: import options

9724f95

chore: docs

9b4b8d2

gagik commented Oct 23, 2025

View reviewed changes

gagik marked this pull request as ready for review October 23, 2025 12:43

gagik added 2 commits October 23, 2025 14:44

chore: cleanup

ed38888

chore: more cleanup

39d7918

gagik commented Oct 23, 2025

View reviewed changes

nirinchev reviewed Oct 23, 2025

View reviewed changes

gagik added 4 commits October 23, 2025 15:14

chore: use binary, use named not positional arguments

18e6d27

chore: format

ac1e696

chore: use app-token publishing

ce2d6cf

chore: use token publishing

e42a448

gagik force-pushed the gagik/publish-marketplace branch from ed41cc3 to e42a448 Compare October 23, 2025 13:24

chore: add clarifications

2ad52a6

gagik commented Oct 23, 2025

View reviewed changes

nirinchev reviewed Oct 23, 2025

View reviewed changes

gagik added 5 commits October 23, 2025 15:57

chore: make args optional

106e28a

chore: remove id-token, move publish step

54563a5

chore: use defaults

f7cd64a

chore: add default to vector and headers, format

8ff4eef

chore: add voyage api key default

a01db62

gagik force-pushed the gagik/publish-marketplace branch from 6ba4c47 to a01db62 Compare October 23, 2025 14:40

chore: move argument generation to prepare-release

97c7585

gagik force-pushed the gagik/publish-marketplace branch from 160fe40 to 97c7585 Compare October 23, 2025 15:02

jeroenvervaeke approved these changes Oct 23, 2025

View reviewed changes

gagik force-pushed the gagik/publish-marketplace branch from ece3085 to 5e82dc1 Compare October 23, 2025 16:06

chore: move to publish job, fix description

d3b80f5

gagik force-pushed the gagik/publish-marketplace branch from 5e82dc1 to d3b80f5 Compare October 23, 2025 16:08

gagik enabled auto-merge (squash) October 23, 2025 16:11

gagik merged commit b6bfdfe into main Oct 23, 2025
19 checks passed

gagik deleted the gagik/publish-marketplace branch October 23, 2025 16:22

chore: add MCP registry publishing #679

chore: add MCP registry publishing #679

Conversation

gagik commented Oct 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gagik Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gagik Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gagik Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gagik Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gagik Oct 23, 2025 •

edited

Loading

gagik Oct 23, 2025 •

edited

Loading

gagik Oct 23, 2025 •

edited

Loading

gagik Oct 23, 2025 •

edited

Loading