Appendix B: errors and lints¶
Error categories¶
| Category | Raise | Retryable | Reference |
|---|---|---|---|
validation |
InvalidInput |
no | validation |
authentication |
AuthenticationRequired |
no | authentication |
permission |
PermissionDenied |
no | permission |
not_found |
NotFound |
no | not found |
rate_limit |
RateLimited |
yes | rate limit |
transient |
TransientError |
yes | transient |
ambiguous_write |
AmbiguousWrite |
no | ambiguous write |
internal |
any other exception | no | internal |
The category pages list the error codes, such as approval_declined, unknown_tool and result_too_large.
Lints¶
| Rule | Catches | Chapter |
|---|---|---|
| undocumented-parameter | A parameter with no description | 2 |
| description-too-short | A description that does not say what the tool does and returns | 2 |
| missing-usage-guidance | A description that never says when to use the tool | 2 |
| inconsistent-tool-names | Names that mix styles | 2 |
| free-form-input | An argument that accepts any structure | 3 |
| budget-override-without-reason | A raised budget without budget_reason |
3 |
| unpaginated-list | An unbounded list without a cursor | 4 |
| write-without-side-effects | A write that does not say what it changes | 6 |
| elicit-in-write | A write that asks the user mid-way | 6 |
| input-after-effect | Asking for input after a write started | 6 |
| destructive-without-policy | A destructive tool anyone can call | 7 |
| stdio-skips-policy | Policies that do not run over stdio | 7 |