Rename mcp.json to server.json (#106)
<!-- Provide a brief summary of your changes --> Rename mcp.json to server.json ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## 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) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> Related to #86 Co-authored-by: Avinash Sridhar <sridharavinash@users.noreply.github.com>
This commit is contained in:
parent
3df06d38d9
commit
d16328e8c1
4 changed files with 5 additions and 5 deletions
2
.vscode/launch.json
vendored
2
.vscode/launch.json
vendored
|
|
@ -21,7 +21,7 @@
|
||||||
"program": "${workspaceFolder}/tools/publisher/main.go",
|
"program": "${workspaceFolder}/tools/publisher/main.go",
|
||||||
"args": [
|
"args": [
|
||||||
"-registry-url=http://localhost:8080",
|
"-registry-url=http://localhost:8080",
|
||||||
"-mcp-file=${workspaceFolder}/tools/publisher/mcp.json",
|
"-mcp-file=${workspaceFolder}/tools/publisher/server.json",
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
|
||||||
|
|
@ -47,7 +47,7 @@ The tool has been simplified to use **GitHub OAuth device flow authentication ex
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
1. Prepare your `mcp.json` file with your server details:
|
1. Prepare your `server.json` file with your server details:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
|
@ -90,7 +90,7 @@ The tool has been simplified to use **GitHub OAuth device flow authentication ex
|
||||||
2. Run the publisher tool:
|
2. Run the publisher tool:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./bin/mcp-publisher --registry-url "https://mcp-registry.example.com" --mcp-file "./mcp.json"
|
./bin/mcp-publisher --registry-url "https://mcp-registry.example.com" --mcp-file "./server.json"
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Follow the authentication instructions in the terminal if prompted.
|
3. Follow the authentication instructions in the terminal if prompted.
|
||||||
|
|
@ -103,5 +103,5 @@ The tool has been simplified to use **GitHub OAuth device flow authentication ex
|
||||||
- **Automatic Client ID**: The GitHub Client ID is automatically retrieved from the registry's health endpoint
|
- **Automatic Client ID**: The GitHub Client ID is automatically retrieved from the registry's health endpoint
|
||||||
- **Token Storage**: The authentication token is saved in `.mcpregistry_token` in the current directory
|
- **Token Storage**: The authentication token is saved in `.mcpregistry_token` in the current directory
|
||||||
- **Internet Required**: Active internet connection needed for GitHub authentication and registry communication
|
- **Internet Required**: Active internet connection needed for GitHub authentication and registry communication
|
||||||
- **Repository Access**: Ensure the repository and package mentioned in your `mcp.json` file exist and are accessible
|
- **Repository Access**: Ensure the repository and package mentioned in your `server.json` file exist and are accessible
|
||||||
- **OAuth Permissions**: You may need to grant the OAuth app access to your GitHub organizations if publishing org repositories
|
- **OAuth Permissions**: You may need to grant the OAuth app access to your GitHub organizations if publishing org repositories
|
||||||
|
|
|
||||||
|
|
@ -85,7 +85,7 @@ func publishToRegistry(registryURL string, mcpData []byte, token string) error {
|
||||||
var mcpDetails map[string]interface{}
|
var mcpDetails map[string]interface{}
|
||||||
err := json.Unmarshal(mcpData, &mcpDetails)
|
err := json.Unmarshal(mcpData, &mcpDetails)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("error parsing mcp.json file: %w", err)
|
return fmt.Errorf("error parsing server.json file: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create the publish request payload (without authentication)
|
// Create the publish request payload (without authentication)
|
||||||
|
|
|
||||||
57
tools/publisher/server.json
Normal file
57
tools/publisher/server.json
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
{
|
||||||
|
"description": "<your description here>",
|
||||||
|
"name": "io.github.<owner>/<server-name>",
|
||||||
|
"packages": [
|
||||||
|
{
|
||||||
|
"registry_name": "npm",
|
||||||
|
"name": "io.github.<owner>/<server-name>",
|
||||||
|
"version": "0.2.23",
|
||||||
|
"package_arguments": [
|
||||||
|
{
|
||||||
|
"description": "Specify services and permissions.",
|
||||||
|
"is_required": true,
|
||||||
|
"format": "string",
|
||||||
|
"value": "-s",
|
||||||
|
"default": "-s",
|
||||||
|
"type": "positional",
|
||||||
|
"value_hint": "-s"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"environment_variables": [
|
||||||
|
{
|
||||||
|
"description": "API Key to access the server",
|
||||||
|
"name": "API_KEY"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},{
|
||||||
|
"registry_name": "docker>",
|
||||||
|
"name": "io.github.<owner>/<server-name>-cli",
|
||||||
|
"version": "0.123.223",
|
||||||
|
"runtime_hint": "docker",
|
||||||
|
"runtime_arguments": [
|
||||||
|
{
|
||||||
|
"description": "Specify services and permissions.",
|
||||||
|
"is_required": true,
|
||||||
|
"format": "string",
|
||||||
|
"value": "--mount",
|
||||||
|
"default": "--mount",
|
||||||
|
"type": "positional",
|
||||||
|
"value_hint": "--mount"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"environment_variables": [
|
||||||
|
{
|
||||||
|
"description": "API Key to access the server",
|
||||||
|
"name": "API_KEY"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/<owner>/<server-name>",
|
||||||
|
"source": "github"
|
||||||
|
},
|
||||||
|
"version_detail": {
|
||||||
|
"version": "0.0.1-<publisher_version>"
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue