Skip to content

Commit 924cbdd

Browse files
committed
ai(rules[AGENTS{docs}]): Document {tool} vs {tooliconl} role conventions
why: Codify when to use each Sphinx cross-reference role for MCP tools. what: - {tool} for headers, bulleted lists, and tables - {tooliconl} for inline paragraph text - {toolref} for dense sequences - {tooliconil}/{tooliconir} for compact lists
1 parent cb7b153 commit 924cbdd

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,13 @@ EOF
339339

340340
## Documentation Standards
341341

342+
### Sphinx Cross-Reference Roles for MCP Tools
343+
344+
- `{tool}` — code chip + full safety badge (text + icon). Use in **headers, bulleted lists, and tables** where the badge provides scannable context.
345+
- `{tooliconl}` — code chip + small colored square icon (left). Use in **inline paragraph text** where the full badge is too visually heavy.
346+
- `{toolref}` — code chip only, no badge. Use for **dense inline sequences** or explanatory text where the safety tier is already established.
347+
- `{tooliconil}` / `{tooliconir}` — bare emoji inside code chip. Use for **compact lists and scan-heavy surfaces**.
348+
342349
### Code Blocks in Documentation
343350

344351
When writing documentation (README, CHANGES, docs/), follow these rules for code blocks:

0 commit comments

Comments
 (0)