Skip to content

README.md

Latest commit

 

History

History
88 lines (63 loc) · 5.16 KB

README.md

File metadata and controls

88 lines (63 loc) · 5.16 KB
Raw

dsh-office-tools

Eight model-facing Office file tools for DeepSeek Harness, running entirely in the plugin host half.

npm version ci License: MIT Listed on awesome-dsh-plugin

Install: dsh plugin --profile web add github:kw78/dsh-office-tools

Tool Purpose Library
word_create Create .docx (title, paragraphs, bullets, one table) docx
word_read Extract text from .docx; format: "markdown" renders headings, lists, and tables structurally jszip (in-house extractor)
word_update Append paragraphs, bullets, and/or a table to an existing .docx docx + jszip
excel_create Create a multi-sheet .xlsx from scalar cell grids SheetJS (xlsx)
excel_read Read one or all sheets as scalar rows; formulas return cached values or '=…' strings SheetJS
excel_update Replace/create whole sheets, or write cells by A1 address SheetJS
ppt_create Create a 16:9 .pptx (title slide, titles, paragraphs, bullets, notes, PNG/JPG/GIF images) pptxgenjs
ppt_read Extract per-slide paragraphs, tables, speaker notes, image counts, and image alt texts jszip

String cells starting with = are written as real Excel formulas (Excel computes them on open).

Harness integration

The plugin follows the standard DSH host-plugin contract:

  • It exports name / inject / apply / Config; inject = ['tools'] is its only runtime service dependency (@deepseek-ai/dsh-tools).
  • apply(ctx) wraps every ctx.tools.register(defineTool({...})) in ctx.effect(...) so Cordis disposes the registrations with the plugin fiber.
  • defineTool declares model-visible parameters, a validated canonical output.schema, and a pure output.render text projection.
  • execute(args, exec) resolves every path against exec.agent.session.header.cwd; relative paths stay in the session workspace and absolute paths are accepted only when still inside it. A realpath check on the nearest existing ancestor closes the symlink escape hatch.
  • Image files must live inside the session workspace (.png/.jpg/.jpeg/.gif, 20 MiB each); explicit inch coordinates x/y/w/h are supported, or omit them for automatic placement below the text.
  • Writes go through a same-directory temp file + rename; overwrite defaults to false.

Build

pnpm install
pnpm run check   # typecheck + tests + build

Artifacts: lib/index.js (ESM host bundle with Office libraries inlined; @deepseek-ai/* and cordis stay external) and lib/types/**/*.d.ts.

Install

# npm (recommended)
dsh plugin --profile web add dsh-office-tools

# GitHub source
dsh plugin --profile web add github:kw78/dsh-office-tools

# local checkout
dsh plugin --profile web add /path/to/dsh-office-tools

Restart the DSH server after installation. The eight tools appear in the next prompt assembly.

Configuration

The plugin declares a schemastery Config the Loader validates at load time. One option exists today:

Option Type Default Effect
enablePptTools boolean true Register ppt_create / ppt_read. Set to false to load this plugin for Word/Excel only.

enablePptTools: false exists for coexistence: dedicated presentation plugins such as dsh-ppt also register a ppt_create, and DSH refuses duplicate tool names at startup (tool "ppt_create" is already registered). Disable the PPT pair here and let the dedicated plugin own presentations:

# profile cordis.patch.yml
- insert:
    - id: dsh-office-tools
      config:
        enablePptTools: false

Community indexes

  • Registration blocks for awesome-dsh-plugin / dsh-market are in docs/hub-registration.md.
  • Recommended repository topics: dsh, dsh-plugin, deepseek-harness, office.

Safety

  • All file access is confined to the calling agent's session workspace.
  • Reads are capped at 50 MiB compressed; before anything is inflated, the archive's own declared sizes are checked against budgets (256 MiB per entry, 512 MiB per archive, 100 000 entries), so zip bombs are refused rather than decompressed. XML parts carrying DOCTYPE/ENTITY declarations are refused outright.
  • Text/cell results are bounded and mark truncated.
  • Creates/updates are bounded by row and cell limits and refuse overwrites by default.
  • No LibreOffice/PowerPoint/Word subprocess is spawned; formats are generated and parsed with pure-JS libraries.
  • SheetJS is pinned to the 0.20.3 tarball from the official CDN (https://cdn.sheetjs.com): npm stopped at 0.18.5, which carries CVE-2023-30533 (prototype pollution) and CVE-2024-22363 (ReDoS). The library is inlined into lib/index.js at build time and never resolved at runtime, so installs of the published plugin do not touch the CDN.
  • Roadmap: docs/ROADMAP.md.