Skip to content

Docs: add optional server readiness metadata template #4390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kmishra1204 wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

Docs: add optional server readiness metadata template #4390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,33 @@ On Windows, apply the same wrapper to each `npx`-based entry above by changing `

Interested in creating your own MCP server? Visit the official documentation at [modelcontextprotocol.io](https://modelcontextprotocol.io/introduction) for comprehensive guides, best practices, and technical details on implementing MCP servers.

## 🧾 Optional Server Readiness Metadata

For teams evaluating server maturity, maintainers may optionally document a compact readiness metadata block per reference server.

Suggested fields:

- Maintainer or owning team
- Last updated date
- Authentication model (none, token, OAuth, delegated)
- Supported transports (stdio, streamable HTTP, SSE)
- Security policy link
- License

Example:

```yaml
server_readiness:
maintainer: mcp-steering-group
updated: 2026-06-19
auth: token
transports: [stdio, streamable-http]
security: https://github.com/modelcontextprotocol/servers/blob/main/SECURITY.md
license: Apache-2.0
```

This metadata is optional and can help reduce repeated due-diligence effort across organizations.

## 📚 Learn More

See [ADDITIONAL.md](ADDITIONAL.md) for a curated list of frameworks and resources that simplify building MCP servers and clients.
Expand Down
Loading