editor/packages/dapi/README.md
konstantin-paulus 7a95fada7a Refactor MCP integration and update dependencies
- Removed the `@modelcontextprotocol/sdk` dependency from `package-lock.json` and `package.json`.
- Updated the CLI client to connect via Streamable HTTP instead of a socket, enhancing communication with the MCP server.
- Simplified the `ping` and `call` functions in `cli-client.ts` to utilize the new connection method.
- Removed the `mcp-proxy.ts` file as it is no longer needed with the new HTTP integration.
- Updated documentation to reflect changes in MCP server access and removed references to the socket transport.
- Cleaned up unused imports and refactored related code for improved clarity and maintainability.
2026-09-12 09:18:46 +02:00

16 lines
847 B
Markdown

# @diffusionstudio/dapi
The tool catalog behind `dapi`: one entry per tool with its name, description, and zod input and output schemas. The app registers the catalog with its MCP server, the renderer validates incoming calls against it, and the CLI derives its commands and help text from it, so the API is described exactly once.
```ts
import { catalog, toolByName, Time } from "@diffusionstudio/dapi";
import type { ToolArgs, ToolResult } from "@diffusionstudio/dapi";
const grab = toolByName("media_grab");
const args: ToolArgs<"media_grab"> = grab.input.parse({ path: "/clip.mp4", times: ["45f", "1:10"] });
```
The package is free of Node built-ins so the renderer can import it. The MCP URL the app serves on (`MCP_URL`) is exported too, for the CLI and the docs the app writes.
Design: [docs/mcp-server.md](../../docs/mcp-server.md).