@struktoai/mirage-core/dist/workspace/tools/tool_descriptions.d.ts

A Unified Virtual Filesystem For AI Agents

/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `shell`.
 */
export declare const SHELL_DESCRIPTION: string;
/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `read`.
 */
export declare const READ_DESCRIPTION: string;
/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `write`.
 */
export declare const WRITE_DESCRIPTION: string;
/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `edit`.
 */
export declare const EDIT_DESCRIPTION: string;
/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `ls`.
 */
export declare const LS_DESCRIPTION = "List files and directories at the given path on the Mirage virtual filesystem.";
/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `grep`.
 */
export declare const GREP_DESCRIPTION: string;
/**
 * The text a Mirage tool gives the model, shared by the MCP server and every
 * adapter that serves Mirage's tool table.
 *
 * This one describes `glob`.
 */
export declare const GLOB_DESCRIPTION: string;
export declare const SHELL_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly command: {
            readonly type: "string";
            readonly description: "The command line to run.";
        };
    };
    readonly required: readonly ["command"];
};
export declare const READ_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly path: {
            readonly type: "string";
            readonly description: "Absolute path of the file to read.";
        };
        readonly offset: {
            readonly type: "integer";
            readonly minimum: 0;
            readonly description: "First line to return, zero-based (default 0).";
        };
        readonly limit: {
            readonly type: "integer";
            readonly minimum: 1;
            readonly description: "Maximum number of lines to return (default 2000).";
        };
    };
    readonly required: readonly ["path"];
};
export declare const WRITE_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly path: {
            readonly type: "string";
            readonly description: "Absolute path of the file to write.";
        };
        readonly content: {
            readonly type: "string";
            readonly description: "The text to write.";
        };
    };
    readonly required: readonly ["path", "content"];
};
export declare const EDIT_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly path: {
            readonly type: "string";
            readonly description: "Absolute path of the file to edit.";
        };
        readonly old_string: {
            readonly type: "string";
            readonly description: "The exact text to replace.";
        };
        readonly new_string: {
            readonly type: "string";
            readonly description: "The text to put in its place.";
        };
        readonly replace_all: {
            readonly type: "boolean";
            readonly description: "Replace every occurrence instead of exactly one (default false).";
        };
    };
    readonly required: readonly ["path", "old_string", "new_string"];
};
export declare const LS_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly path: {
            readonly type: "string";
            readonly description: "Absolute path of the directory to list.";
        };
    };
    readonly required: readonly ["path"];
};
export declare const GREP_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly pattern: {
            readonly type: "string";
            readonly description: "Regular expression to search for.";
        };
        readonly path: {
            readonly type: "string";
            readonly description: "Absolute path of the file or directory to search under.";
        };
        readonly ignore_case: {
            readonly type: "boolean";
            readonly description: "Match case-insensitively (-i).";
        };
        readonly fixed_strings: {
            readonly type: "boolean";
            readonly description: "Read pattern as a literal string, not a regex (-F).";
        };
        readonly include: {
            readonly type: "string";
            readonly description: "Search only files whose name matches this glob, such as *.py (--include).";
        };
        readonly context: {
            readonly type: "integer";
            readonly minimum: 0;
            readonly description: "Lines of context to print around each match (-C).";
        };
        readonly files_with_matches: {
            readonly type: "boolean";
            readonly description: "Print only the names of files that match (-l).";
        };
        readonly count: {
            readonly type: "boolean";
            readonly description: "Print only a count of matching lines per file (-c).";
        };
        readonly max_count: {
            readonly type: "integer";
            readonly minimum: 1;
            readonly description: "Stop each file after this many matching lines (-m).";
        };
    };
    readonly required: readonly ["pattern", "path"];
};
export declare const GLOB_INPUT: {
    readonly type: "object";
    readonly properties: {
        readonly pattern: {
            readonly type: "string";
            readonly description: "Pathname pattern such as **/*.py or src/*.ts; a relative one is matched under path.";
        };
        readonly path: {
            readonly type: "string";
            readonly description: "Absolute path of the directory a relative pattern is matched under (default /).";
        };
    };
    readonly required: readonly ["pattern"];
};
//# sourceMappingURL=tool_descriptions.d.ts.map