@cueai/omni-reader-mcp 1.0.0

package/README.md

@@ -0,0 +1,49 @@
+# @cue/omni-reader-mcp
+
+Local stdio MCP Bridge for parsing files from an Agent workspace through Omni Reader. Source bytes upload directly from the local Bridge to IIIS; they do not pass through Cube-MCP or the model conversation before `parse_document` is called.
+
+## Requirements
+
+- Node.js 20.12 or newer
+- A Cue API Key from <https://cuecue.cn/hub/api-key>
+
+## Setup
+
+Set the existing general Cue API Key, then run the interactive user-scope setup:
+
+```sh
+export CUE_API_KEY="YOUR_CUE_API_KEY"
+npx -y @cue/omni-reader-mcp setup
+```
+
+Setup supports Cursor, Claude Desktop, and a generic MCP configuration for other Agents. The current working directory is allowed by default. To allow additional directories, provide them during setup or configure absolute paths in `OMNI_ALLOWED_ROOTS` (colon-separated on macOS/Linux and semicolon-separated on Windows).
+
+The Bridge reads only these production environment variables:
+
+- `CUE_API_KEY`
+- `OMNI_ALLOWED_ROOTS`
+
+## Daily use
+
+Tell the Agent the local path as ordinary text:
+
+```text
+用 Omni 解析 ./report.pdf
+```
+
+For local documents, pass the exact user-provided path to parse_document.
+Do not read, attach, base64-encode, or insert the file content into the
+conversation before calling this tool. Do not use @file as a prerequisite.
+Use parse_url for HTTP(S) URLs.
+
+Local parsing defaults to `no_store=true`. Files are restricted to configured roots, one regular file per invocation, with a maximum size of 256 MiB.
+
+## Commands
+
+```sh
+npx -y @cue/omni-reader-mcp setup
+npx -y @cue/omni-reader-mcp doctor
+npx -y @cue/omni-reader-mcp clean
+```
+
+Running `npx -y @cue/omni-reader-mcp` without a command starts the stdio MCP server.

package/dist/artifact-store.d.ts

@@ -0,0 +1,65 @@
+import type { FileHandle } from "node:fs/promises";
+import type { ReleasedMetadata, ResultRetentionSink, ResultRetentionStart } from "./iiis-client.js";
+export interface ArtifactStoreOptions {
+    readonly rootDirectory?: string;
+    readonly projectDirectory?: string;
+    readonly retentionMs?: number;
+    readonly now?: () => Date;
+}
+export interface DefaultArtifactRootOptions {
+    readonly platform?: NodeJS.Platform;
+    readonly homeDirectory?: string;
+    readonly env?: Readonly<Record<string, string | undefined>>;
+}
+export interface InlineResult extends ReleasedMetadata {
+    readonly kind: "inline";
+    readonly text: string;
+}
+export interface ArtifactResult extends ReleasedMetadata {
+    readonly kind: "artifact";
+    readonly resultId: string;
+    readonly artifactPath: string;
+    readonly expiresAt: string;
+    readonly preview: string;
+    readonly nextCursor?: string;
+}
+export type LocalResult = InlineResult | ArtifactResult;
+export interface ArtifactReadResult {
+    readonly resultId: string;
+    readonly resultBytes: number;
+    readonly expiresAt: string;
+    readonly text: string;
+    readonly nextCursor?: string;
+}
+interface ArtifactFinalizeInput extends ReleasedMetadata {
+    readonly resultId: string;
+}
+export declare function defaultArtifactRoot(options?: DefaultArtifactRootOptions): string;
+export declare class ArtifactStore {
+    #private;
+    private constructor();
+    static open(options?: ArtifactStoreOptions): Promise<ArtifactStore>;
+    get rootDirectory(): string;
+    createRetention(): LocalResultRetention;
+    read(resultId: string, cursor?: string, maxBytes?: number): Promise<ArtifactReadResult>;
+    discard(resultId: string): Promise<boolean>;
+    cleanupExpired(): Promise<number>;
+    close(): Promise<void>;
+    _finalizeArtifact(temporaryPath: string, metadata: ArtifactFinalizeInput): Promise<ArtifactResult>;
+    _newTemporaryArtifact(): Promise<{
+        resultId: string;
+        temporaryPath: string;
+        handle: FileHandle;
+    }>;
+}
+export declare class LocalResultRetention implements ResultRetentionSink {
+    #private;
+    constructor(store: ArtifactStore);
+    reset(): Promise<void>;
+    begin(metadata: ResultRetentionStart): Promise<void>;
+    write(chunk: Uint8Array): Promise<void>;
+    complete(metadata: ReleasedMetadata): Promise<void>;
+    result(): LocalResult;
+    abort(): Promise<void>;
+}
+export {};