Spaces:
Paused
Paused
Commit
·
3e57670
1
Parent(s):
b22b05b
docs: add example mcp.json for client usage
Browse files
README.md
CHANGED
|
@@ -101,9 +101,10 @@ README.md # Project documentation
|
|
| 101 |
.env.example # Example environment configuration
|
| 102 |
```
|
| 103 |
|
| 104 |
-
##
|
| 105 |
-
|
| 106 |
-
|
|
|
|
| 107 |
|
| 108 |
```json
|
| 109 |
{
|
|
@@ -131,4 +132,29 @@ For public spaces, you can omit the `hf-access-token` input or `Authorization` h
|
|
| 131 |
"password": true
|
| 132 |
}
|
| 133 |
]
|
| 134 |
-
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 101 |
.env.example # Example environment configuration
|
| 102 |
```
|
| 103 |
|
| 104 |
+
## `mcp.json` Configuration Example for Client Usage
|
| 105 |
+
To use this MCP server in a client application that supports MCP, you add the config below to `mcp.json`.
|
| 106 |
+
|
| 107 |
+
#### PRIVATE MCP SERVER: This config is required for when deploying the MCP server in a private Hugging Face Space that requires authentication.
|
| 108 |
|
| 109 |
```json
|
| 110 |
{
|
|
|
|
| 132 |
"password": true
|
| 133 |
}
|
| 134 |
]
|
| 135 |
+
}
|
| 136 |
+
```
|
| 137 |
+
|
| 138 |
+
#### PUBLIC MCP SERVER: For public spaces, you can omit the `hf-access-token` input or `Authorization` header.
|
| 139 |
+
|
| 140 |
+
```json
|
| 141 |
+
{
|
| 142 |
+
"servers": {
|
| 143 |
+
"ds": {
|
| 144 |
+
"url": "https://dnext-ds-mcp-server.hf.space/mcp/",
|
| 145 |
+
"type": "http",
|
| 146 |
+
"headers": {
|
| 147 |
+
"DS-API-Key": "${input:defect-solver-api-key}"
|
| 148 |
+
}
|
| 149 |
+
}
|
| 150 |
+
},
|
| 151 |
+
"inputs": [
|
| 152 |
+
{
|
| 153 |
+
"type": "promptString",
|
| 154 |
+
"id": "defect-solver-api-key",
|
| 155 |
+
"description": "Enter your Defect Solver API Key",
|
| 156 |
+
"password": true
|
| 157 |
+
}
|
| 158 |
+
]
|
| 159 |
+
}
|
| 160 |
+
```
|