Spaces:
Paused
Paused
update readme and landing page
Browse files- README.md +55 -39
- index.html +18 -5
README.md
CHANGED
|
@@ -18,40 +18,48 @@ This server allows MCP clients to:
|
|
| 18 |
- ๐ค Query [wandbot](https://github.com/wandb/wandbot), the W&B support agent
|
| 19 |
- ๐ Write text and charts to W&B Reports
|
| 20 |
|
| 21 |
-
## ๐ Quick Start - Use This
|
| 22 |
|
| 23 |
-
###
|
| 24 |
|
| 25 |
-
|
| 26 |
-
2. **Set your W&B API Key** in your duplicated Space:
|
| 27 |
-
- Go to Settings โ "Variables and secrets"
|
| 28 |
-
- Add a new secret: `WANDB_API_KEY` with your key from [wandb.ai/authorize](https://wandb.ai/authorize)
|
| 29 |
-
3. **Use your personal MCP server endpoint**:
|
| 30 |
-
```
|
| 31 |
-
https://huggingface.co/spaces/[your-username]/[your-space-name]/mcp
|
| 32 |
-
```
|
| 33 |
|
| 34 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 35 |
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
If the Space owner has configured a public API key, you can use the public endpoint directly:
|
| 39 |
-
```
|
| 40 |
-
https://huggingface.co/spaces/[original-space]/mcp
|
| 41 |
-
```
|
| 42 |
-
|
| 43 |
-
โ ๏ธ **Note**: The public Space will only have access to projects accessible by the configured API key.
|
| 44 |
|
| 45 |
## ๐ฅ๏ธ Using with MCP Clients
|
| 46 |
|
| 47 |
-
### Mistral
|
| 48 |
-
1. Go to
|
| 49 |
-
2.
|
| 50 |
-
|
| 51 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 52 |
|
| 53 |
-
###
|
| 54 |
-
|
| 55 |
|
| 56 |
## ๐ง Available MCP Tools
|
| 57 |
|
|
@@ -81,37 +89,45 @@ Show me the latest 10 runs from my experiment tracking project and create a repo
|
|
| 81 |
What's the best performing model in my latest sweep? Plot the results.
|
| 82 |
```
|
| 83 |
|
| 84 |
-
##
|
|
|
|
|
|
|
| 85 |
|
| 86 |
-
|
| 87 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 88 |
|
| 89 |
-
|
| 90 |
-
- `MCP_SERVER_LOG_LEVEL`: Set to `DEBUG` for verbose logging (default: `WARNING`)
|
| 91 |
-
- `PORT`: Server port (automatically set by HuggingFace Spaces)
|
| 92 |
|
| 93 |
## ๐ Troubleshooting
|
| 94 |
|
| 95 |
-
###
|
| 96 |
-
1. **
|
| 97 |
-
2. **
|
| 98 |
-
3. **
|
| 99 |
|
| 100 |
### Query Tips
|
| 101 |
- Always specify your W&B entity and project name in queries
|
| 102 |
- Be specific rather than overly broad in your questions
|
| 103 |
- Verify you have access to the projects you're querying
|
| 104 |
|
| 105 |
-
##
|
| 106 |
|
| 107 |
-
|
|
|
|
|
|
|
|
|
|
| 108 |
|
| 109 |
## ๐ Resources
|
| 110 |
|
| 111 |
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
| 112 |
- [Weights & Biases Documentation](https://docs.wandb.ai/)
|
| 113 |
- [W&B Weave Documentation](https://weave-docs.wandb.ai/)
|
| 114 |
-
- [Source Code
|
|
|
|
| 115 |
|
| 116 |
## ๐ License
|
| 117 |
|
|
|
|
| 18 |
- ๐ค Query [wandbot](https://github.com/wandb/wandbot), the W&B support agent
|
| 19 |
- ๐ Write text and charts to W&B Reports
|
| 20 |
|
| 21 |
+
## ๐ Quick Start - Use This Server Directly!
|
| 22 |
|
| 23 |
+
### No Setup Required! ๐
|
| 24 |
|
| 25 |
+
You can use this server immediately with your own W&B API key:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
|
| 27 |
+
1. **Get your W&B API key** from [wandb.ai/authorize](https://wandb.ai/authorize)
|
| 28 |
+
2. **Configure your MCP client** with:
|
| 29 |
+
- **Server URL**: `https://niware-wandb-mcp-server.hf.space/mcp`
|
| 30 |
+
- **Authentication**: Your W&B API key as Bearer token
|
| 31 |
+
3. **Start querying** your W&B data!
|
| 32 |
|
| 33 |
+
That's it! No server configuration, no duplication needed. Each user provides their own API key, ensuring secure access to their own W&B projects.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
## ๐ฅ๏ธ Using with MCP Clients
|
| 36 |
|
| 37 |
+
### Mistral LeChat
|
| 38 |
+
1. Go to Settings โ Custom MCP Connectors
|
| 39 |
+
2. Add a new connector:
|
| 40 |
+
- **Server URL**: `https://niware-wandb-mcp-server.hf.space/mcp`
|
| 41 |
+
- **Authentication**: Choose "API Key Authentication"
|
| 42 |
+
- **API Key**: Your W&B API key from [wandb.ai/authorize](https://wandb.ai/authorize)
|
| 43 |
+
|
| 44 |
+
### Cursor
|
| 45 |
+
Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
|
| 46 |
+
```json
|
| 47 |
+
{
|
| 48 |
+
"mcpServers": {
|
| 49 |
+
"wandb": {
|
| 50 |
+
"transport": "http",
|
| 51 |
+
"url": "https://niware-wandb-mcp-server.hf.space/mcp",
|
| 52 |
+
"headers": {
|
| 53 |
+
"Authorization": "Bearer YOUR_WANDB_API_KEY",
|
| 54 |
+
"Accept": "application/json, text/event-stream"
|
| 55 |
+
}
|
| 56 |
+
}
|
| 57 |
+
}
|
| 58 |
+
}
|
| 59 |
+
```
|
| 60 |
|
| 61 |
+
### Claude Desktop / Claude Code
|
| 62 |
+
Configure in your MCP settings with the server URL and Bearer token authentication.
|
| 63 |
|
| 64 |
## ๐ง Available MCP Tools
|
| 65 |
|
|
|
|
| 89 |
What's the best performing model in my latest sweep? Plot the results.
|
| 90 |
```
|
| 91 |
|
| 92 |
+
## ๐ป Run Locally (Optional)
|
| 93 |
+
|
| 94 |
+
Want to run your own instance or develop locally? Check out the main repository:
|
| 95 |
|
| 96 |
+
```bash
|
| 97 |
+
# Install and run from source
|
| 98 |
+
git clone https://github.com/wandb/wandb-mcp-server
|
| 99 |
+
cd wandb-mcp-server
|
| 100 |
+
uv run src/wandb_mcp_server/server.py --transport http
|
| 101 |
+
```
|
| 102 |
|
| 103 |
+
See the [GitHub repository](https://github.com/wandb/wandb-mcp-server) for installation instructions for various MCP clients.
|
|
|
|
|
|
|
| 104 |
|
| 105 |
## ๐ Troubleshooting
|
| 106 |
|
| 107 |
+
### Connection Issues?
|
| 108 |
+
1. **Verify your API key**: Ensure it's correctly copied from [wandb.ai/authorize](https://wandb.ai/authorize)
|
| 109 |
+
2. **Check the endpoint**: Must include `/mcp` suffix: `https://niware-wandb-mcp-server.hf.space/mcp`
|
| 110 |
+
3. **Headers required**: Include both `Authorization` and `Accept` headers as shown above
|
| 111 |
|
| 112 |
### Query Tips
|
| 113 |
- Always specify your W&B entity and project name in queries
|
| 114 |
- Be specific rather than overly broad in your questions
|
| 115 |
- Verify you have access to the projects you're querying
|
| 116 |
|
| 117 |
+
## ๐ Security
|
| 118 |
|
| 119 |
+
- **Your API key is never stored** - It's only used transiently for your requests
|
| 120 |
+
- **Each user is isolated** - Your key only accesses your W&B data
|
| 121 |
+
- **No server configuration needed** - The server doesn't have its own W&B access
|
| 122 |
+
- **Industry-standard Bearer tokens** - Same pattern as GitHub, OpenAI, etc.
|
| 123 |
|
| 124 |
## ๐ Resources
|
| 125 |
|
| 126 |
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
| 127 |
- [Weights & Biases Documentation](https://docs.wandb.ai/)
|
| 128 |
- [W&B Weave Documentation](https://weave-docs.wandb.ai/)
|
| 129 |
+
- [Source Code Repository](https://github.com/wandb/wandb-mcp-server)
|
| 130 |
+
- [Get Your W&B API Key](https://wandb.ai/authorize)
|
| 131 |
|
| 132 |
## ๐ License
|
| 133 |
|
index.html
CHANGED
|
@@ -204,7 +204,7 @@
|
|
| 204 |
</div>
|
| 205 |
|
| 206 |
<div class="endpoint">
|
| 207 |
-
https://
|
| 208 |
</div>
|
| 209 |
|
| 210 |
<div class="features">
|
|
@@ -229,13 +229,14 @@
|
|
| 229 |
</div>
|
| 230 |
</div>
|
| 231 |
|
| 232 |
-
<div class="setup-steps">
|
| 233 |
-
<h3
|
| 234 |
<ol>
|
| 235 |
<li>Get your W&B API key from <a href="https://wandb.ai/authorize" target="_blank">wandb.ai/authorize</a></li>
|
| 236 |
-
<li>
|
| 237 |
-
<li>
|
| 238 |
</ol>
|
|
|
|
| 239 |
</div>
|
| 240 |
|
| 241 |
<div class="examples">
|
|
@@ -251,6 +252,18 @@
|
|
| 251 |
</div>
|
| 252 |
</div>
|
| 253 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 254 |
<div class="footer">
|
| 255 |
<p>
|
| 256 |
Built with โค๏ธ for the <a href="https://modelcontextprotocol.io/" target="_blank">Model Context Protocol</a> community
|
|
|
|
| 204 |
</div>
|
| 205 |
|
| 206 |
<div class="endpoint">
|
| 207 |
+
https://niware-wandb-mcp-server.hf.space/mcp
|
| 208 |
</div>
|
| 209 |
|
| 210 |
<div class="features">
|
|
|
|
| 229 |
</div>
|
| 230 |
</div>
|
| 231 |
|
| 232 |
+
<div class="setup-steps" style="background: #f0fdf4; border-color: #86efac;">
|
| 233 |
+
<h3 style="color: #166534;">โ
Ready to Use!</h3>
|
| 234 |
<ol>
|
| 235 |
<li>Get your W&B API key from <a href="https://wandb.ai/authorize" target="_blank">wandb.ai/authorize</a></li>
|
| 236 |
+
<li>Configure your MCP client with the endpoint above</li>
|
| 237 |
+
<li>Provide your API key as Bearer token or API Key authentication</li>
|
| 238 |
</ol>
|
| 239 |
+
<p style="margin-top: 15px; color: #166534;"><strong>No server configuration needed!</strong> Each user provides their own API key for secure access to their W&B data.</p>
|
| 240 |
</div>
|
| 241 |
|
| 242 |
<div class="examples">
|
|
|
|
| 252 |
</div>
|
| 253 |
</div>
|
| 254 |
|
| 255 |
+
<div style="background: #e0e7ff; padding: 20px; border-radius: 8px; margin: 30px 0; text-align: center;">
|
| 256 |
+
<h3 style="color: #312e81; margin: 0 0 10px 0;">๐ Want to Run Your Own Instance?</h3>
|
| 257 |
+
<p style="color: #4c4999; margin: 10px 0;">
|
| 258 |
+
Install locally or deploy your own server from the open-source repository:
|
| 259 |
+
</p>
|
| 260 |
+
<a href="https://github.com/wandb/wandb-mcp-server" target="_blank"
|
| 261 |
+
style="display: inline-block; background: #4c1d95; color: white; padding: 10px 20px;
|
| 262 |
+
border-radius: 6px; text-decoration: none; margin-top: 10px;">
|
| 263 |
+
View on GitHub โ
|
| 264 |
+
</a>
|
| 265 |
+
</div>
|
| 266 |
+
|
| 267 |
<div class="footer">
|
| 268 |
<p>
|
| 269 |
Built with โค๏ธ for the <a href="https://modelcontextprotocol.io/" target="_blank">Model Context Protocol</a> community
|