Files
accounted/extensions/general/mcp-server/tool-result.ts
T
Jakob Wennberg ec27228a8e style: remove em/en dashes repo-wide, add CLAUDE.md rule against them (#890)
Em dashes (—) and en dashes (–) had spread across comments, docs, tests,
and a few UI strings, reading as AI-generated boilerplate rather than
house style. Replaced each with punctuation matching its context: colon
for explanatory clauses, comma for asides, plain hyphen for numeric/legal
ranges (e.g. "21-23§"), "to"/"till" for date ranges, parentheses for
paired-dash asides. messages/en.json and messages/sv.json were fixed by
hand together to keep sv/en in sync.

Left untouched where the dash is the functional subject rather than
decorative punctuation: date-range-parser.ts's separator regex,
charset-repair.ts's CP1252 byte-mapping table (and its test), the SIE
encoding mojibake docs, generic-csv.ts's minus-sign normalizer, the
agent system-prompt files that already instruct against em dashes, and
a golden iXBRL test fixture compared byte-for-byte.

Also fixes two bugs surfaced along the way: an off-by-one in
ApiKeysPanel's scope-label split (a leftover from an earlier partial
pass), and a charset-repair test that had lost the literal en-dash it
exists to verify.

Regenerated the agent atom seed migration (skills:generate) since 27
SKILL.md files changed. Added a CLAUDE.md rule against em/en dashes,
with an explicit carve-out for the functional-dash cases above.

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-04 15:58:06 +02:00

58 lines
2.0 KiB
TypeScript

/**
* Helpers for shaping MCP tool results in an agent-actionable form.
*
* Two additive concepts:
* 1. `next`: when a tool succeeds and there's an obvious follow-up tool or
* resource the agent should call, expose it directly so Claude doesn't
* have to re-derive it from prose.
* 2. structured errors: failures include a stable code, English + Swedish
* messages, and a remediation hint when one exists.
*
* Both are folded into the JSON `text` payload that the JSON-RPC handler
* already serializes: no protocol change needed, and existing string-only
* consumers keep working.
*/
import { getStructuredError, type StructuredError } from '@/lib/errors/get-structured-error'
export interface NextActionHint {
description: string
tool?: string
args?: Record<string, unknown>
resource?: string
}
export interface AgentToolResult<T = unknown> {
data: T
next?: NextActionHint
}
export interface AgentToolError {
error: StructuredError
}
/**
* Wrap a successful tool payload with an optional `next` hint. Returns the
* payload as-is if the input is already wrapped (idempotent), or a plain object
* if no hint is supplied.
*/
export function withNext<T>(data: T, next?: NextActionHint): AgentToolResult<T> {
return next ? { data, next } : { data }
}
/**
* Convert a thrown error into the structured tool-error envelope the agent
* sees. If the error is a string already containing "Insufficient scope:",
* the attempted scope is propagated to the remediation hint so the agent can
* surface a precise request to the user.
*/
export function toToolError(err: unknown, opts: { toolName?: string } = {}): AgentToolError {
let attemptedScope: string | undefined
const message = err instanceof Error ? err.message : typeof err === 'string' ? err : ''
const scopeMatch = message.match(/Insufficient scope: this API key does not have the "([^"]+)" scope/)
if (scopeMatch) attemptedScope = scopeMatch[1]
return {
error: getStructuredError(err, { attemptedScope, toolName: opts.toolName }),
}
}