Tianyi Cui
30c1863755
Rename per review naming decisions: - package dsh-file-context → dsh-fs-policy (dir, package name, plugin name, tsconfig refs, importers, type-equiv manifest, generated catalog + module-graph) - events fs/write-expectation → fs/write-intent, fs/edit-expectation → fs/edit-intent (fs/observed unchanged); type FsWriteExpectation → FsWriteIntent, "expectation" wording → "intent" throughout - exported FileContextExec → FsPolicyExec Make the implemented RFCs describe what shipped, not the superseded designs: the 2026-06-17 capability-seam + tool-schemas RFCs no longer place policy on ctx.fs or use full/partial-view authorization, and the fsspec RFC's ctx.fileContext service prose is rewritten to the fs/* event-gate reality (freshness-based auth). Sharpen docs/rfc/implemented/AGENTS.md: a rename is a fact to fix IN PLACE — the "new RFC" escape hatch is for macro decision reversals only, not renames. Code fixes from review: - fsio.ts resolveLocalTarget/probe translate ENOTDIR (a parent path segment is a file) into the structured FsError taxonomy instead of leaking a raw Node error; resolve reports FS_NOT_FOUND, probe reports absent. Regression tests proven to fail on the unfixed code. - tool-fs HMR test now asserts prompt sections (not just tool schemas) are withdrawn on disposal. - fs/observed is a plain (unguarded) ctx.emit: correct the fs-policy comment, filesystem.md, and tool-fs module doc that wrongly claimed the tool "contains" a throwing listener; a throw surfaces as the tool's isError result. - drop the false "loaded by the default product config" claim (no config wires the fs tools yet), the duplicate ctx.bash service-map row, the stale FileReadRequest catalog link-map entry, and the fs/fs README EOF blank line; correct the dsh-fs package.json description.
48 lines
2.2 KiB
TypeScript
48 lines
2.2 KiB
TypeScript
/**
|
|
* The model-facing filesystem tool suite (`read`, `write`, `edit`) over the
|
|
* `ctx.fs` provider seam. This single plugin registers all three tools.
|
|
*
|
|
* ## The tool is the executor; policy is an event gate
|
|
*
|
|
* The tool reads/writes/edits through `ctx.fs` DIRECTLY and owns model-facing
|
|
* concerns only — tool names, JSON schemas, argument validation, prompt
|
|
* sections, read windowing, result formatting. It does NOT inject a policy
|
|
* service. Instead, on each write/edit it dispatches a single-slot waterfall
|
|
* (`fs/write-intent`/`fs/edit-intent`) to obtain the OPTIONAL version guard, and
|
|
* after every read/write/edit it emits `fs/observed` with a plain (unguarded)
|
|
* `ctx.emit`. A policy plugin (`@deepseek-ai/dsh-fs-policy`) occupies the
|
|
* decision slot and listens for `fs/observed` to add observed-state +
|
|
* read-before-edit + version-guarded write/edit; a deployment that loads these
|
|
* tools is expected to also load it. With no policy plugin the waterfalls fall
|
|
* through to their `undefined` default (the unconstrained bare provider) and
|
|
* `fs/observed` is unheard — the tool still functions. This package never
|
|
* imports `node:fs`, `node:path`, or an `@deepseek-ai/dsh-fs-local`
|
|
* implementation.
|
|
*
|
|
* @module @deepseek-ai/dsh-tool-fs
|
|
*/
|
|
|
|
import type { Context } from 'cordis'
|
|
import { applyReadTool } from './read.ts'
|
|
import { applyWriteTool } from './write.ts'
|
|
import { applyEditTool } from './edit.ts'
|
|
|
|
export { READ_LIMIT, STREAM_MIN_SIZE, applyReadTool, parseReadArgs } from './read.ts'
|
|
export { applyWriteTool, formatWriteOutput, parseWriteArgs } from './write.ts'
|
|
export { applyEditTool, formatEditOutput, parseEditArgs } from './edit.ts'
|
|
export { READ_MAX_BYTES, READ_MAX_LINE_LENGTH, buildWindow, formatReadOutput } from './read-render.ts'
|
|
export type { FileReadOutcome, FileTextLine, ReadWindow, WindowResult } from './read-render.ts'
|
|
|
|
/** Cordis plugin name used by loader diagnostics. */
|
|
export const name = 'tool-fs'
|
|
|
|
/** Services required by the filesystem tool suite. */
|
|
export const inject = ['tools', 'fs', 'systemPrompt']
|
|
|
|
/** Register the full `read`/`write`/`edit` filesystem tool suite. */
|
|
export function apply(ctx: Context): void {
|
|
applyReadTool(ctx)
|
|
applyWriteTool(ctx)
|
|
applyEditTool(ctx)
|
|
}
|