Watch

adam jones 2e7108d366

Big docs tidy up in preparation for launch (#364 )

## Motivation and Context
Docs currently don't have very clear organisation, and don't explain
core flows.

This fixes #89 (although we still might want to push these to
`https://modelcontextprotocol.io/docs/`), based on the plan there.

One minor change from that plan is that I merged tutorials and guides,
because they ended up basically being duplicates which I thought would
be annoying for us to keep in sync. Additionally in the Diátaxis
framework, tutorials and guides are separated by whether they are
focused on acquisition of skills (e.g. in a learning environment) or
application of skills (e.g. in a work environment). I expect the
registry to be something that will be used occasionally in a work
environment, rather than a fundamental 'learnable' skill so I think it's
reasonable not to have tutorials and fold these into guides.

## How Has This Been Tested?
- Read through all these updated docs
- Unit and integration tests (that previously used examples.md and use
the schema) working
- Ran `npx markdown-link-check .` to check all the links work

## Breaking Changes
Links to old docs will break, but I don't think there are any. All
internal links have been checked and updated.

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] 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)
- [x] Documentation update

2025-09-07 10:44:42 +01:00

1.2 KiB

Raw Blame History

Admin Operations

This is a brief guide for admins and moderators managing content on the registry. All actions should be taken in line with the moderation guidelines.

Prerequisites

Admin account with @modelcontextprotocol.io email
- If you are a maintainer and would like an account, ask in the Discord
gcloud CLI installed and configured
curl and jq installed

Authentication

# Run this, then run the export command it outputs
./tools/admin/auth.sh

Edit a Server

Step 1: Download Server

export SERVER_ID="<server-uuid>"
curl -s "https://registry.modelcontextprotocol.io/v0/servers/${SERVER_ID}" > server.json

Step 2: Open server.json and make changes. You cannot change the server name.

Step 3: Push Changes

curl -X PUT "https://registry.modelcontextprotocol.io/v0/servers/${SERVER_ID}" \
  -H "Authorization: Bearer ${REGISTRY_TOKEN}" \
  -H "Content-Type: application/json" \
  -d "{\"server\": $(cat server.json)}"

Takedown a Server

export SERVER_ID="<server-uuid>"
./tools/admin/takedown.sh

This soft deletes the server. If you need to delete the content of a server (usually only where legally necessary), use the edit workflow above to scrub it all.

1.2 KiB Raw Blame History