@aakrit512/gatekeep 1.0.0

package/dist/functions/toolDefinitions.js

@@ -0,0 +1,422 @@
+export const tools = [
+    {
+        type: 'function',
+        function: {
+            name: 'list_directory',
+            description: 'List contents of a directory to understand project layout.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    dir_path: {
+                        type: 'string',
+                        description: 'Path to list, e.g., "./src"',
+                    },
+                },
+                required: ['dir_path'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'read_file',
+            description: 'Read the contents of a local file.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                },
+                required: ['file_path'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'read_file_chunk',
+            description: 'Read a targeted excerpt from a local file by start/end line or by zero-based offset and limit. Useful for long files where full reads are wasteful.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                    start_line: {
+                        type: 'number',
+                        description: '1-based line number to start reading from.',
+                    },
+                    end_line: {
+                        type: 'number',
+                        description: '1-based inclusive line number to stop reading at.',
+                    },
+                    offset: {
+                        type: 'number',
+                        description: 'Zero-based line offset. Used when start_line is omitted.',
+                    },
+                    limit: {
+                        type: 'number',
+                        description: 'Maximum number of lines to return. Defaults to 200.',
+                    },
+                },
+                required: ['file_path'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'search_files',
+            description: 'Search filenames by glob, partial name, or extension. Useful for finding config, route, env, auth, test, and build files quickly.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    query: {
+                        type: 'string',
+                        description: 'Partial filename, extension such as ".ts", or glob such as "**/*.config.ts".',
+                    },
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to search from. Defaults to the workspace root.',
+                    },
+                    max_results: {
+                        type: 'number',
+                        description: 'Maximum number of paths to return. Defaults to 100.',
+                    },
+                    include_hidden: {
+                        type: 'boolean',
+                        description: 'Whether to include dotfiles and hidden directories. Defaults to false.',
+                    },
+                },
+                required: ['query'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'grep_code',
+            description: 'Full-text or regex search across files, with optional include/exclude globs. Use for finding usages, env vars, API routes, imports, and symbols.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    pattern: {
+                        type: 'string',
+                        description: 'Text or regular expression to search for.',
+                    },
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to search from. Defaults to the workspace root.',
+                    },
+                    regex: {
+                        type: 'boolean',
+                        description: 'Treat pattern as a JavaScript regular expression. Defaults to false.',
+                    },
+                    case_sensitive: {
+                        type: 'boolean',
+                        description: 'Case-sensitive matching. Defaults to true.',
+                    },
+                    include_globs: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        description: 'Only search files matching any of these globs, e.g. ["src/**/*.ts"].',
+                    },
+                    exclude_globs: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        description: 'Skip files matching any of these globs.',
+                    },
+                    max_results: {
+                        type: 'number',
+                        description: 'Maximum matching lines to return. Defaults to 100.',
+                    },
+                },
+                required: ['pattern'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'get_file_metadata',
+            description: 'Return size, modified time, line count, language, and checksum for a file so the agent can decide whether it is worth opening.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                },
+                required: ['file_path'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'get_project_tree',
+            description: 'Return a recursive tree view with depth and ignore support to understand project architecture better than a flat directory listing.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to start from. Defaults to the workspace root.',
+                    },
+                    depth: {
+                        type: 'number',
+                        description: 'Maximum directory depth to include. Defaults to 3.',
+                    },
+                    ignore: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        description: 'Glob or partial path patterns to ignore.',
+                    },
+                    include_hidden: {
+                        type: 'boolean',
+                        description: 'Whether to include dotfiles and hidden directories. Defaults to false.',
+                    },
+                    max_entries: {
+                        type: 'number',
+                        description: 'Maximum number of entries to return. Defaults to 500.',
+                    },
+                },
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'find_symbol',
+            description: 'Find class, function, type, interface, enum, const, let, or var definitions by name. Faster than generic grep for "where is this implemented?" questions.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    symbol: {
+                        type: 'string',
+                        description: 'Symbol name to find.',
+                    },
+                    kind: {
+                        type: 'string',
+                        description: 'Optional definition kind: class, function, type, interface, enum, const, let, or var.',
+                    },
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to search from. Defaults to the workspace root.',
+                    },
+                    max_results: {
+                        type: 'number',
+                        description: 'Maximum definitions to return. Defaults to 50.',
+                    },
+                },
+                required: ['symbol'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'find_references',
+            description: 'Return call sites or usages of a symbol across source files. Useful for tracing feature flow safely in read-only mode.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    symbol: {
+                        type: 'string',
+                        description: 'Symbol name to search for.',
+                    },
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to search from. Defaults to the workspace root.',
+                    },
+                    include_definitions: {
+                        type: 'boolean',
+                        description: 'Whether to include definition lines. Defaults to false.',
+                    },
+                    max_results: {
+                        type: 'number',
+                        description: 'Maximum references to return. Defaults to 100.',
+                    },
+                },
+                required: ['symbol'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'get_imports_exports',
+            description: 'Return a quick snapshot of module imports and exports for a file to show module boundaries and dependency direction.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                },
+                required: ['file_path'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'summarize_file',
+            description: 'Produce a compact machine-readable summary of a file: purpose hint, symbols, dependencies, exports, and likely side effects.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                    max_symbols: {
+                        type: 'number',
+                        description: 'Maximum symbols to include. Defaults to 30.',
+                    },
+                },
+                required: ['file_path'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'list_dependencies',
+            description: 'Read package.json, lockfiles, Dockerfiles, and build files to identify runtime and tooling dependencies for stack analysis.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    dir_path: {
+                        type: 'string',
+                        description: 'Project directory to inspect. Defaults to the workspace root.',
+                    },
+                    include_dev: {
+                        type: 'boolean',
+                        description: 'Whether to include development dependencies. Defaults to true.',
+                    },
+                    max_files: {
+                        type: 'number',
+                        description: 'Maximum dependency-related files to inspect. Defaults to 50.',
+                    },
+                },
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'read_manifest_files',
+            description: 'Auto-detect and read key repo manifests such as package.json, pnpm-workspace.yaml, turbo.json, tsconfig.json, docker-compose.yml, .github/workflows/*, and README*.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    dir_path: {
+                        type: 'string',
+                        description: 'Project directory to inspect. Defaults to the workspace root.',
+                    },
+                    max_files: {
+                        type: 'number',
+                        description: 'Maximum manifest files to read. Defaults to 40.',
+                    },
+                    max_bytes_per_file: {
+                        type: 'number',
+                        description: 'Maximum bytes to return per manifest. Defaults to 20000.',
+                    },
+                },
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'list_git_status',
+            description: 'Return staged, unstaged, and untracked file lists for quick situational awareness without the full diff.',
+            parameters: {
+                type: 'object',
+                properties: {},
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'blame_file_range',
+            description: 'Run git blame for a targeted file range to understand historical intent behind unusual code.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                    start_line: {
+                        type: 'number',
+                        description: '1-based start line.',
+                    },
+                    end_line: {
+                        type: 'number',
+                        description: '1-based inclusive end line.',
+                    },
+                },
+                required: ['file_path', 'start_line', 'end_line'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'find_entrypoints',
+            description: 'Detect likely app entry files, route roots, workers, CLIs, and server bootstrap files to shorten execution-flow discovery.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to search from. Defaults to the workspace root.',
+                    },
+                    max_results: {
+                        type: 'number',
+                        description: 'Maximum entrypoints to return. Defaults to 100.',
+                    },
+                },
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'list_routes',
+            description: 'Extract known web routes or route files from conventions and common backend frameworks such as Next.js, Express, Nest, and Fastify.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    dir_path: {
+                        type: 'string',
+                        description: 'Directory to search from. Defaults to the workspace root.',
+                    },
+                    max_results: {
+                        type: 'number',
+                        description: 'Maximum routes to return. Defaults to 200.',
+                    },
+                },
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'write_file',
+            description: 'Write content to a file. Creates directories if they do not exist.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    file_path: { type: 'string' },
+                    content: {
+                        type: 'string',
+                        description: 'Markdown or code content',
+                    },
+                },
+                required: ['file_path', 'content'],
+            },
+        },
+    },
+    {
+        type: 'function',
+        function: {
+            name: 'get_git_diff',
+            description: 'Returns three sections: (1) uncommitted working-tree changes, (2) staged changes, (3) last 10 commits with file stats. Use this to understand what has changed recently — but an empty diff does NOT mean nothing to review.',
+            parameters: {
+                type: 'object',
+                properties: {},
+            },
+        },
+    },
+];