Skip to content

Commit def3d5d

Browse files
committed
Replace manual go commands with make targets in README
1 parent 4f975da commit def3d5d

File tree

1 file changed

+12
-73
lines changed

1 file changed

+12
-73
lines changed

README.md

Lines changed: 12 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -51,31 +51,31 @@ The easiest way to get the registry running is uses docker compose. This will se
5151
make dev-compose
5252
```
5353

54-
This will start the MCP Registry service and MongoDB with Docker, exposing it on port 8080.
54+
This will start the MCP Registry service and MongoDB with Docker, running at [`localhost:8080`](http://localhost:8080).
5555

5656
## Building
5757

58-
If you prefer to run the service locally without Docker, you can build and run it directly using Go.
58+
If you prefer to run the service locally without Docker, you can build and run it directly:
5959

6060
```bash
6161
# Build a registry executable
6262
make build
6363
```
6464
This will create the `registry` binary in the current directory. You'll need to have MongoDB running locally or with Docker.
6565

66-
You can also run the service directly:
66+
To run the service locally:
6767
```bash
68-
# Direct execution
69-
go run cmd/registry/main.go
68+
# Run registry locally (requires MongoDB)
69+
make dev-local
7070
```
7171

72-
By default, the service will run on `http://localhost:8080`.
72+
By default, the service will run on [`localhost:8080`](http://localhost:8080).
7373

74-
There is also a CLI tool to publish MCP servers to the registry. You can build it with:
74+
To build the CLI tool for publishing MCP servers to the registry:
7575

7676
```bash
7777
# Build the publisher tool
78-
cd tools/publisher && ./build.sh
78+
make publisher
7979
```
8080

8181
## Development
@@ -91,14 +91,14 @@ make help
9191
Key development commands:
9292

9393
```bash
94-
# Build targets
95-
make build # Build the registry application
96-
make publisher # Build the publisher tool
97-
9894
# Development
9995
make dev-compose # Start development environment with Docker Compose
10096
make dev-local # Run registry locally (requires MongoDB)
10197

98+
# Build targets
99+
make build # Build the registry application
100+
make publisher # Build the publisher tool
101+
102102
# Testing
103103
make test-unit # Run unit tests with coverage report
104104
make test-integration # Run integration tests
@@ -417,67 +417,6 @@ The service can be configured using environment variables:
417417
| `MCP_REGISTRY_SEED_IMPORT` | Import `seed.json` on first run | `true` |
418418
| `MCP_REGISTRY_SERVER_ADDRESS` | Listen address for the server | `:8080` |
419419

420-
421-
## Testing
422-
423-
### Unit Tests
424-
425-
```bash
426-
# Run unit tests with coverage
427-
make test
428-
429-
# Generate coverage report
430-
make coverage
431-
```
432-
433-
### Integration Tests
434-
435-
```bash
436-
# Run integration tests
437-
make integration-test
438-
```
439-
440-
### API Endpoint Testing
441-
442-
```bash
443-
# Test API endpoints (requires running server)
444-
make test-endpoints
445-
```
446-
447-
You can also run the script directly with specific endpoints:
448-
449-
```bash
450-
./scripts/test_endpoints.sh --endpoint health
451-
./scripts/test_endpoints.sh --endpoint servers
452-
```
453-
454-
### Publish Endpoint Testing
455-
456-
```bash
457-
# Test publish endpoint (requires BEARER_TOKEN env var)
458-
make test-publish
459-
```
460-
461-
### Validation
462-
463-
```bash
464-
# Validate JSON schemas
465-
make validate-schemas
466-
467-
# Validate examples against schemas
468-
make validate-examples
469-
470-
# Run all validation checks
471-
make validate
472-
```
473-
474-
### Comprehensive Testing
475-
476-
```bash
477-
# Run all checks (lint, validate, test)
478-
make check
479-
```
480-
481420
## License
482421

483422
See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)