Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (63 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

93 lines (63 loc) · 3.3 KB

Contributing

Development setup

This repo uses pnpm for package management and the active LTS version of Node.js. Node.js and pnpm versions are managed via mise (see mise.toml).

Why mise? We use mise to ensure all contributors use consistent versions of tools, reducing instances where code behaves differently on different machines. This is useful not only for managing Node.js and pnpm versions, but also binaries published outside of the npm ecosystem such as the MCP Publisher CLI.

Clone the repo and run:

mise install
pnpm install

To build the MCP server and watch for file changes:

cd packages/mcp-server-supabase
pnpm dev

Configure your MCP client to run the local build. You may need to restart the server in your MCP client after each change.

{
  "mcpServers": {
    "supabase": {
      "command": "node",
      "args": [
        "/path/to/supabase-mcp/packages/mcp-server-supabase/dist/transports/stdio.js",
        "--project-ref",
        "<your project ref>"
      ],
      "env": {
        "SUPABASE_ACCESS_TOKEN": "<your pat>"
      }
    }
  }
}

Optionally, configure --api-url to point at a different Supabase instance (defaults to https://api.supabase.com)

Releases

Releases are automated via release-please. It tracks commits on main and opens a release PR when there are releasable changes (fix: or feat:). Merging that PR:

  1. Creates a GitHub release and git tag for each package
  2. Publishes updated packages to npm
  3. Publishes the MCP server to the MCP registry

Most contributors don't need to do anything beyond merging the release PR and updating downstream apps.

If the release PR gets into a bad state, close it and manually re-run the workflow from the Actions tab → Run workflow. release-please will recreate the PR from scratch.

If the workflow creates GitHub releases and tags but fails before publishing to npm or the MCP registry, re-run the workflow from one of the release tags created by the failed workflow run and enable force_publish.

Manual MCP registry publish (optional)

This is only needed if the automated publish failed or needs to be re-run manually. The MCP registry stores metadata about the server (defined in packages/mcp-server-supabase/server.json) — it does not host the server itself.

Dependencies

You will need mcp-publisher installed. It's already pinned in mise.toml, so if you have mise set up just run:

mise install

Steps

  1. Update server.json with the new version by running:

    pnpm registry:update

  2. Download the domain-verification-key.pem from Bitwarden and place it in packages/mcp-server-supabase/. This will be used to verify ownership of the supabase.com domain during the login process.

    This works because of the .well-known/mcp-registry-auth endpoint served by supabase.com.

  3. Login to the MCP registry:

    pnpm registry:login

  4. Publish:

    pnpm registry:publish