@greynewell/mcpbr 0.3.22 → 0.3.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -402,6 +402,45 @@ mcp_server:
|
|
|
402
402
|
SUPERMODEL_API_KEY: "${SUPERMODEL_API_KEY}"
|
|
403
403
|
```
|
|
404
404
|
|
|
405
|
+
### MCP Timeout Configuration
|
|
406
|
+
|
|
407
|
+
mcpbr supports configurable timeouts for MCP server operations to handle different server types and workloads.
|
|
408
|
+
|
|
409
|
+
#### Configuration Fields
|
|
410
|
+
|
|
411
|
+
| Field | Description | Default |
|
|
412
|
+
|-------|-------------|---------|
|
|
413
|
+
| `startup_timeout_ms` | Timeout in milliseconds for MCP server startup | 60000 (60s) |
|
|
414
|
+
| `tool_timeout_ms` | Timeout in milliseconds for MCP tool execution | 900000 (15 min) |
|
|
415
|
+
|
|
416
|
+
These fields map to the `MCP_TIMEOUT` and `MCP_TOOL_TIMEOUT` environment variables used by Claude Code. See the [Claude Code settings documentation](https://code.claude.com/docs/en/settings.md) for more details.
|
|
417
|
+
|
|
418
|
+
#### Example Configuration
|
|
419
|
+
|
|
420
|
+
```yaml
|
|
421
|
+
mcp_server:
|
|
422
|
+
command: "npx"
|
|
423
|
+
args: ["-y", "@modelcontextprotocol/server-filesystem", "{workdir}"]
|
|
424
|
+
startup_timeout_ms: 60000 # 60 seconds for server to start
|
|
425
|
+
tool_timeout_ms: 900000 # 15 minutes for long-running tools
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
#### Common Timeout Values
|
|
429
|
+
|
|
430
|
+
Different server types require different timeout settings based on their operational characteristics:
|
|
431
|
+
|
|
432
|
+
| Server Type | startup_timeout_ms | tool_timeout_ms | Notes |
|
|
433
|
+
|-------------|-------------------|-----------------|-------|
|
|
434
|
+
| Fast (filesystem, git) | 10000 (10s) | 30000 (30s) | Local operations with minimal overhead |
|
|
435
|
+
| Medium (web search, APIs) | 30000 (30s) | 120000 (2m) | Network I/O with moderate latency |
|
|
436
|
+
| Slow (code analysis, databases) | 60000 (60s) | 900000 (15m) | Complex processing or large datasets |
|
|
437
|
+
|
|
438
|
+
**When to adjust timeouts:**
|
|
439
|
+
|
|
440
|
+
- **Increase `startup_timeout_ms`** if your server takes longer to initialize (e.g., loading large models, establishing database connections)
|
|
441
|
+
- **Increase `tool_timeout_ms`** if your tools perform long-running operations (e.g., codebase analysis, file processing, AI inference)
|
|
442
|
+
- **Decrease timeouts** for fast servers to fail quickly on connection issues
|
|
443
|
+
|
|
405
444
|
### Custom Agent Prompt
|
|
406
445
|
|
|
407
446
|
You can customize the prompt sent to the agent using the `agent_prompt` field:
|
|
@@ -1050,6 +1089,30 @@ pytest
|
|
|
1050
1089
|
ruff check src/
|
|
1051
1090
|
```
|
|
1052
1091
|
|
|
1092
|
+
### Creating Releases
|
|
1093
|
+
|
|
1094
|
+
We use an automated workflow for releases. See the **[Release Guide](docs/RELEASE.md)** for full details.
|
|
1095
|
+
|
|
1096
|
+
**Quick start for maintainers:**
|
|
1097
|
+
```bash
|
|
1098
|
+
# Patch release (bug fixes) - most common
|
|
1099
|
+
gh workflow run release.yml -f version_bump=patch
|
|
1100
|
+
|
|
1101
|
+
# Minor release (new features)
|
|
1102
|
+
gh workflow run release.yml -f version_bump=minor
|
|
1103
|
+
|
|
1104
|
+
# Major release (breaking changes)
|
|
1105
|
+
gh workflow run release.yml -f version_bump=major
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
**For AI agents:** See the **[AI Agent Guide](docs/AI_AGENT_GUIDE.md)** for a quick reference.
|
|
1109
|
+
|
|
1110
|
+
The workflow automatically:
|
|
1111
|
+
- Bumps version in `pyproject.toml`
|
|
1112
|
+
- Syncs version to all package files
|
|
1113
|
+
- Creates git tag and GitHub release
|
|
1114
|
+
- Triggers PyPI and npm publication
|
|
1115
|
+
|
|
1053
1116
|
## Roadmap
|
|
1054
1117
|
|
|
1055
1118
|
We're building the defacto standard for MCP server benchmarking! Our [v1.0 Roadmap](https://github.com/greynewell/mcpbr/projects/2) includes 200+ features across 11 strategic categories:
|