Skip to content

Commit 84a547c

Browse files
authored
📝 docs: better readme, notion language guide (#190)
1 parent 513cbd8 commit 84a547c

3 files changed

Lines changed: 15 additions & 16 deletions

File tree

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -125,28 +125,21 @@ python -m src.aggregators.aggregate_results --exp-name exp
125125

126126
Please visit `docs/introduction.md` for choices of *MODEL*.
127127

128-
Tip: MCPMark supports **auto-resume**. When re-running commands, only unfinished tasks will execute. Tasks previously failed due to pipeline errors (e.g., `State Duplication Error`, `MCP Network Error`) will be retried automatically.
128+
Tip: MCPMark supports **auto-resume**. When re-running, only unfinished tasks will execute. Failures matching our retryable patterns (see [RETRYABLE_PATTERNS](src/errors.py)) are retried automatically. Models may emit different error strings—if you encounter a new resumable error, please open a PR or issue.
129129

130130
---
131131

132132
## Service setup and authentication
133133

134-
- **Notion**: environment isolation (Source Hub / Eval Hub), integration creation and grants, browser login verification.
135-
- Guide and Setup: `docs/mcp/notion.md`
134+
| Service | Setup summary | Docs |
135+
|-------------|-----------------------------------------------------------------------------------------------------------------|---------------------------------------|
136+
| Notion | Environment isolation (Source Hub / Eval Hub), integration creation and grants, browser login verification. | [Guide](docs/mcp/notion.md) |
137+
| GitHub | Multi-account token pooling recommended; import pre-exported repo state if needed. | [Guide](docs/mcp/github.md) |
138+
| Postgres | Start via Docker and import sample databases. | [Setup](docs/mcp/postgres.md) |
139+
| Playwright | Install browsers before first run; defaults to `chromium`. | [Setup](docs/mcp/playwright.md) |
140+
| Filesystem | Zero-configuration, run directly. | [Config](docs/mcp/filesystem.md) |
136141

137-
- **GitHub**: multi-account token pooling recommended; import pre-exported repo state if needed.
138-
- Guide and Setup: `docs/mcp/github.md`
139-
140-
- **Postgres**: start via Docker and import sample databases.
141-
- Env setup: `docs/mcp/postgres.md`
142-
143-
- **Playwright**: install browsers before first run; defaults to `chromium`.
144-
- Env setup: `docs/mcp/playwright.md`
145-
146-
- **Filesystem**: zero-configuration, run directly.
147-
- Configuration: `docs/mcp/filesystem.md`
148-
149-
You can also follow `docs/quickstart.md` for the shortest end-to-end path.
142+
You can also follow [Quickstart](docs/quickstart.md) for the shortest end-to-end path.
150143

151144
---
152145

docs/mcp/notion.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This guide walks you through preparing your Notion environment for MCPMark and authenticating the CLI tools.
44

5+
> Note: Set your Notion app and workspace interface language to English. We use Playwright for browser automation and our locator logic relies on raw English text in the UI. Non-English interfaces can cause element selection to fail.
6+
57
## 1 · Set up Notion Environment
68

79
1. **Duplicate the MCPMark Source Pages**

src/errors.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@
2020
"internal server error", # 500s
2121
"network error", # generic network issue
2222
"quota", # budget/quota exceeded
23+
# "llm provider not provided", # litellm error
2324
# pipeline infra signals
25+
"double quotes", # actually json error
26+
"account balance",
27+
"expecting value",
2428
"mcp network error",
2529
"state duplication error",
2630
}

0 commit comments

Comments
 (0)