Skip to content

docs: add Chinese README translations and improve main README formatting #22

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.

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 28 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MCP Registry

English | [繁體中文](README.zh-TW.md) | [简体中文](README.zh-CN.md)

A community driven registry service for Model Context Protocol (MCP) servers.

## Development Status
Expand Down Expand Up @@ -50,13 +52,14 @@ If you prefer to run the service locally without Docker, you can build and run i
# Build a registry executable
go build ./cmd/registry
```

This will create the `registry` binary in the current directory. You'll need to have MongoDB running locally or with Docker.

By default, the service will run on `http://localhost:8080`.

## Project Structure

```
```text
├── api/ # OpenApi specification
├── cmd/ # Application entry points
├── config/ # Configuration files
Expand All @@ -75,7 +78,7 @@ By default, the service will run on `http://localhost:8080`.

The API is documented using Swagger/OpenAPI. You can access the interactive Swagger UI at:

```
```text
/v0/swagger/index.html
```

Expand All @@ -85,11 +88,12 @@ This provides a complete reference of all endpoints with request/response schema

### Health Check

```
```text
GET /v0/health
```

Returns the health status of the service:

```json
{
"status": "ok"
Expand All @@ -100,17 +104,19 @@ Returns the health status of the service:

#### List Registry Server Entries

```
```text
GET /v0/servers
```

Lists MCP registry server entries with pagination support.

Query parameters:

- `limit`: Maximum number of entries to return (default: 30, max: 100)
- `cursor`: Pagination cursor for retrieving next set of results

Response example:

```json
{
"servers": [
Expand Down Expand Up @@ -189,17 +195,19 @@ Response example:

#### Publish a Server Entry

```
```text
POST /v0/publish
```

Publishes a new MCP server entry to the registry. Authentication is required via Bearer token in the Authorization header.

Headers:

- `Authorization`: Bearer token for authentication (e.g., `Bearer your_token_here`)
- `Content-Type`: application/json

Request body example:

```json
{
"description": "<your description here>",
Expand Down Expand Up @@ -261,6 +269,7 @@ Request body example:
```

Response example:

```json
{
"message": "Server publication successful",
Expand All @@ -270,11 +279,12 @@ Response example:

### Ping Endpoint

```
```text
GET /v0/ping
```

Simple ping endpoint that returns environment configuration information:

```json
{
"environment": "dev",
Expand All @@ -286,19 +296,18 @@ Simple ping endpoint that returns environment configuration information:

The service can be configured using environment variables:

| Variable | Description | Default |
|----------|-------------|---------|
| `MCP_REGISTRY_APP_VERSION` | Application version | `dev` |
| `MCP_REGISTRY_COLLECTION_NAME` | MongoDB collection name | `servers_v2` |
| `MCP_REGISTRY_DATABASE_NAME` | MongoDB database name | `mcp-registry` |
| `MCP_REGISTRY_DATABASE_URL` | MongoDB connection string | `mongodb://localhost:27017` |
| `MCP_REGISTRY_GITHUB_CLIENT_ID` | GitHub App Client ID | |
| `MCP_REGISTRY_GITHUB_CLIENT_SECRET` | GitHub App Client Secret | |
| `MCP_REGISTRY_LOG_LEVEL` | Log level | `info` |
| `MCP_REGISTRY_SEED_FILE_PATH` | Path to import seed file | `data/seed.json` |
| `MCP_REGISTRY_SEED_IMPORT` | Import `seed.json` on first run | `true` |
| `MCP_REGISTRY_SERVER_ADDRESS` | Listen address for the server | `:8080` |

| Variable | Description | Default |
| ----------------------------------- | ------------------------------- | --------------------------- |
| `MCP_REGISTRY_APP_VERSION` | Application version | `dev` |
| `MCP_REGISTRY_COLLECTION_NAME` | MongoDB collection name | `servers_v2` |
| `MCP_REGISTRY_DATABASE_NAME` | MongoDB database name | `mcp-registry` |
| `MCP_REGISTRY_DATABASE_URL` | MongoDB connection string | `mongodb://localhost:27017` |
| `MCP_REGISTRY_GITHUB_CLIENT_ID` | GitHub App Client ID | |
| `MCP_REGISTRY_GITHUB_CLIENT_SECRET` | GitHub App Client Secret | |
| `MCP_REGISTRY_LOG_LEVEL` | Log level | `info` |
| `MCP_REGISTRY_SEED_FILE_PATH` | Path to import seed file | `data/seed.json` |
| `MCP_REGISTRY_SEED_IMPORT` | Import `seed.json` on first run | `true` |
| `MCP_REGISTRY_SERVER_ADDRESS` | Listen address for the server | `:8080` |

## Testing

Expand Down
Loading