feat(ipuaro): add LLM integration module

- OllamaClient: ILLMClient implementation with tool support
- System prompt and context builders for project overview
- 18 tool definitions across 6 categories (read, edit, search, analysis, git, run)
- XML response parser for tool call extraction
- 98 new tests (419 total), 96.38% coverage
This commit is contained in:
imfozilbek
2025-12-01 00:10:11 +05:00
parent b3e04a411c
commit 68f927d906
12 changed files with 2594 additions and 1 deletions

View File

@@ -1,3 +1,4 @@
// Infrastructure layer exports
export * from "./storage/index.js"
export * from "./indexer/index.js"
export * from "./llm/index.js"

View File

@@ -0,0 +1,302 @@
import { type Message, Ollama, type Tool } from "ollama"
import type {
ILLMClient,
LLMResponse,
ToolDef,
ToolParameter,
} from "../../domain/services/ILLMClient.js"
import type { ChatMessage } from "../../domain/value-objects/ChatMessage.js"
import { createToolCall, type ToolCall } from "../../domain/value-objects/ToolCall.js"
import type { LLMConfig } from "../../shared/constants/config.js"
import { IpuaroError } from "../../shared/errors/IpuaroError.js"
import { estimateTokens } from "../../shared/utils/tokens.js"
/**
* Ollama LLM client implementation.
* Wraps the Ollama SDK for chat completions with tool support.
*/
export class OllamaClient implements ILLMClient {
private readonly client: Ollama
private readonly host: string
private readonly model: string
private readonly contextWindow: number
private readonly temperature: number
private readonly timeout: number
private abortController: AbortController | null = null
constructor(config: LLMConfig) {
this.host = config.host
this.client = new Ollama({ host: this.host })
this.model = config.model
this.contextWindow = config.contextWindow
this.temperature = config.temperature
this.timeout = config.timeout
}
/**
* Send messages to LLM and get response.
*/
async chat(messages: ChatMessage[], tools?: ToolDef[]): Promise<LLMResponse> {
const startTime = Date.now()
this.abortController = new AbortController()
try {
const ollamaMessages = this.convertMessages(messages)
const ollamaTools = tools ? this.convertTools(tools) : undefined
const response = await this.client.chat({
model: this.model,
messages: ollamaMessages,
tools: ollamaTools,
options: {
temperature: this.temperature,
},
stream: false,
})
const timeMs = Date.now() - startTime
const toolCalls = this.extractToolCalls(response.message)
return {
content: response.message.content,
toolCalls,
tokens: response.eval_count ?? estimateTokens(response.message.content),
timeMs,
truncated: false,
stopReason: this.determineStopReason(response, toolCalls),
}
} catch (error) {
if (error instanceof Error && error.name === "AbortError") {
throw IpuaroError.llm("Request was aborted")
}
throw this.handleError(error)
} finally {
this.abortController = null
}
}
/**
* Count tokens in text.
* Uses estimation since Ollama doesn't provide a tokenizer endpoint.
*/
async countTokens(text: string): Promise<number> {
return Promise.resolve(estimateTokens(text))
}
/**
* Check if LLM service is available.
*/
async isAvailable(): Promise<boolean> {
try {
await this.client.list()
return true
} catch {
return false
}
}
/**
* Get current model name.
*/
getModelName(): string {
return this.model
}
/**
* Get context window size.
*/
getContextWindowSize(): number {
return this.contextWindow
}
/**
* Pull/download model if not available locally.
*/
async pullModel(model: string): Promise<void> {
try {
await this.client.pull({ model, stream: false })
} catch (error) {
throw this.handleError(error, `Failed to pull model: ${model}`)
}
}
/**
* Check if a specific model is available locally.
*/
async hasModel(model: string): Promise<boolean> {
try {
const result = await this.client.list()
return result.models.some((m) => m.name === model || m.name.startsWith(`${model}:`))
} catch {
return false
}
}
/**
* List available models.
*/
async listModels(): Promise<string[]> {
try {
const result = await this.client.list()
return result.models.map((m) => m.name)
} catch (error) {
throw this.handleError(error, "Failed to list models")
}
}
/**
* Abort current generation.
*/
abort(): void {
if (this.abortController) {
this.abortController.abort()
}
}
/**
* Convert ChatMessage array to Ollama Message format.
*/
private convertMessages(messages: ChatMessage[]): Message[] {
return messages.map((msg): Message => {
const role = this.convertRole(msg.role)
if (msg.role === "tool" && msg.toolResults) {
return {
role: "tool",
content: msg.content,
}
}
if (msg.role === "assistant" && msg.toolCalls && msg.toolCalls.length > 0) {
return {
role: "assistant",
content: msg.content,
tool_calls: msg.toolCalls.map((tc) => ({
function: {
name: tc.name,
arguments: tc.params,
},
})),
}
}
return {
role,
content: msg.content,
}
})
}
/**
* Convert message role to Ollama role.
*/
private convertRole(role: ChatMessage["role"]): "user" | "assistant" | "system" | "tool" {
switch (role) {
case "user":
return "user"
case "assistant":
return "assistant"
case "system":
return "system"
case "tool":
return "tool"
default:
return "user"
}
}
/**
* Convert ToolDef array to Ollama Tool format.
*/
private convertTools(tools: ToolDef[]): Tool[] {
return tools.map(
(tool): Tool => ({
type: "function",
function: {
name: tool.name,
description: tool.description,
parameters: {
type: "object",
properties: this.convertParameters(tool.parameters),
required: tool.parameters.filter((p) => p.required).map((p) => p.name),
},
},
}),
)
}
/**
* Convert ToolParameter array to JSON Schema properties.
*/
private convertParameters(
params: ToolParameter[],
): Record<string, { type: string; description: string; enum?: string[] }> {
const properties: Record<string, { type: string; description: string; enum?: string[] }> =
{}
for (const param of params) {
properties[param.name] = {
type: param.type,
description: param.description,
...(param.enum && { enum: param.enum }),
}
}
return properties
}
/**
* Extract tool calls from Ollama response message.
*/
private extractToolCalls(message: Message): ToolCall[] {
if (!message.tool_calls || message.tool_calls.length === 0) {
return []
}
return message.tool_calls.map((tc, index) =>
createToolCall(
`call_${String(Date.now())}_${String(index)}`,
tc.function.name,
tc.function.arguments,
),
)
}
/**
* Determine stop reason from response.
*/
private determineStopReason(
response: { done_reason?: string },
toolCalls: ToolCall[],
): "end" | "length" | "tool_use" {
if (toolCalls.length > 0) {
return "tool_use"
}
if (response.done_reason === "length") {
return "length"
}
return "end"
}
/**
* Handle and wrap errors.
*/
private handleError(error: unknown, context?: string): IpuaroError {
const message = error instanceof Error ? error.message : String(error)
const fullMessage = context ? `${context}: ${message}` : message
if (message.includes("ECONNREFUSED") || message.includes("fetch failed")) {
return IpuaroError.llm(`Cannot connect to Ollama at ${this.host}`)
}
if (message.includes("model") && message.includes("not found")) {
return IpuaroError.llm(
`Model "${this.model}" not found. Run: ollama pull ${this.model}`,
)
}
return IpuaroError.llm(fullMessage)
}
}

View File

@@ -0,0 +1,220 @@
import { createToolCall, type ToolCall } from "../../domain/value-objects/ToolCall.js"
/**
* Parsed response from LLM.
*/
export interface ParsedResponse {
/** Text content (excluding tool calls) */
content: string
/** Extracted tool calls */
toolCalls: ToolCall[]
/** Whether parsing encountered issues */
hasParseErrors: boolean
/** Parse error messages */
parseErrors: string[]
}
/**
* XML tool call tag pattern.
* Matches: <tool_call name="tool_name">...</tool_call>
*/
const TOOL_CALL_REGEX = /<tool_call\s+name\s*=\s*"([^"]+)">([\s\S]*?)<\/tool_call>/gi
/**
* XML parameter tag pattern.
* Matches: <param name="param_name">value</param> or <param_name>value</param_name>
*/
const PARAM_REGEX_NAMED = /<param\s+name\s*=\s*"([^"]+)">([\s\S]*?)<\/param>/gi
const PARAM_REGEX_ELEMENT = /<([a-z_][a-z0-9_]*)>([\s\S]*?)<\/\1>/gi
/**
* Parse tool calls from LLM response text.
* Supports XML format: <tool_call name="get_lines"><path>src/index.ts</path></tool_call>
*/
export function parseToolCalls(response: string): ParsedResponse {
const toolCalls: ToolCall[] = []
const parseErrors: string[] = []
let content = response
const matches = [...response.matchAll(TOOL_CALL_REGEX)]
for (const match of matches) {
const [fullMatch, toolName, paramsXml] = match
try {
const params = parseParameters(paramsXml)
const toolCall = createToolCall(
`xml_${String(Date.now())}_${String(toolCalls.length)}`,
toolName,
params,
)
toolCalls.push(toolCall)
content = content.replace(fullMatch, "")
} catch (error) {
const errorMsg = error instanceof Error ? error.message : String(error)
parseErrors.push(`Failed to parse tool call "${toolName}": ${errorMsg}`)
}
}
content = content.trim()
return {
content,
toolCalls,
hasParseErrors: parseErrors.length > 0,
parseErrors,
}
}
/**
* Parse parameters from XML content.
*/
function parseParameters(xml: string): Record<string, unknown> {
const params: Record<string, unknown> = {}
const namedMatches = [...xml.matchAll(PARAM_REGEX_NAMED)]
for (const match of namedMatches) {
const [, name, value] = match
params[name] = parseValue(value)
}
if (namedMatches.length === 0) {
const elementMatches = [...xml.matchAll(PARAM_REGEX_ELEMENT)]
for (const match of elementMatches) {
const [, name, value] = match
params[name] = parseValue(value)
}
}
return params
}
/**
* Parse a value string to appropriate type.
*/
function parseValue(value: string): unknown {
const trimmed = value.trim()
if (trimmed === "true") {
return true
}
if (trimmed === "false") {
return false
}
if (trimmed === "null") {
return null
}
const num = Number(trimmed)
if (!isNaN(num) && trimmed !== "") {
return num
}
if (
(trimmed.startsWith("[") && trimmed.endsWith("]")) ||
(trimmed.startsWith("{") && trimmed.endsWith("}"))
) {
try {
return JSON.parse(trimmed)
} catch {
return trimmed
}
}
return trimmed
}
/**
* Format tool calls to XML for prompt injection.
* Useful when you need to show the LLM the expected format.
*/
export function formatToolCallsAsXml(toolCalls: ToolCall[]): string {
return toolCalls
.map((tc) => {
const params = Object.entries(tc.params)
.map(([key, value]) => ` <${key}>${formatValueForXml(value)}</${key}>`)
.join("\n")
return `<tool_call name="${tc.name}">\n${params}\n</tool_call>`
})
.join("\n\n")
}
/**
* Format a value for XML output.
*/
function formatValueForXml(value: unknown): string {
if (value === null || value === undefined) {
return ""
}
if (typeof value === "object") {
return JSON.stringify(value)
}
if (typeof value === "string") {
return value
}
if (typeof value === "number" || typeof value === "boolean") {
return String(value)
}
return JSON.stringify(value)
}
/**
* Extract thinking/reasoning from response.
* Matches content between <thinking>...</thinking> tags.
*/
export function extractThinking(response: string): { thinking: string; content: string } {
const thinkingRegex = /<thinking>([\s\S]*?)<\/thinking>/gi
const matches = [...response.matchAll(thinkingRegex)]
if (matches.length === 0) {
return { thinking: "", content: response }
}
let content = response
const thoughts: string[] = []
for (const match of matches) {
thoughts.push(match[1].trim())
content = content.replace(match[0], "")
}
return {
thinking: thoughts.join("\n\n"),
content: content.trim(),
}
}
/**
* Check if response contains tool calls.
*/
export function hasToolCalls(response: string): boolean {
return TOOL_CALL_REGEX.test(response)
}
/**
* Validate tool call parameters against expected schema.
*/
export function validateToolCallParams(
toolName: string,
params: Record<string, unknown>,
requiredParams: string[],
): { valid: boolean; errors: string[] } {
const errors: string[] = []
for (const param of requiredParams) {
if (!(param in params) || params[param] === undefined || params[param] === null) {
errors.push(`Missing required parameter: ${param}`)
}
}
return {
valid: errors.length === 0,
errors,
}
}

View File

@@ -0,0 +1,48 @@
// LLM infrastructure exports
export { OllamaClient } from "./OllamaClient.js"
export {
SYSTEM_PROMPT,
buildInitialContext,
buildFileContext,
truncateContext,
type ProjectStructure,
} from "./prompts.js"
export {
ALL_TOOLS,
READ_TOOLS,
EDIT_TOOLS,
SEARCH_TOOLS,
ANALYSIS_TOOLS,
GIT_TOOLS,
RUN_TOOLS,
CONFIRMATION_TOOLS,
requiresConfirmation,
getToolDef,
getToolsByCategory,
GET_LINES_TOOL,
GET_FUNCTION_TOOL,
GET_CLASS_TOOL,
GET_STRUCTURE_TOOL,
EDIT_LINES_TOOL,
CREATE_FILE_TOOL,
DELETE_FILE_TOOL,
FIND_REFERENCES_TOOL,
FIND_DEFINITION_TOOL,
GET_DEPENDENCIES_TOOL,
GET_DEPENDENTS_TOOL,
GET_COMPLEXITY_TOOL,
GET_TODOS_TOOL,
GIT_STATUS_TOOL,
GIT_DIFF_TOOL,
GIT_COMMIT_TOOL,
RUN_COMMAND_TOOL,
RUN_TESTS_TOOL,
} from "./toolDefs.js"
export {
parseToolCalls,
formatToolCallsAsXml,
extractThinking,
hasToolCalls,
validateToolCallParams,
type ParsedResponse,
} from "./ResponseParser.js"

View File

@@ -0,0 +1,335 @@
import type { FileAST } from "../../domain/value-objects/FileAST.js"
import type { FileMeta } from "../../domain/value-objects/FileMeta.js"
/**
* Project structure for context building.
*/
export interface ProjectStructure {
name: string
rootPath: string
files: string[]
directories: string[]
}
/**
* System prompt for the ipuaro AI agent.
*/
export const SYSTEM_PROMPT = `You are ipuaro, a local AI code assistant specialized in helping developers understand and modify their codebase. You operate within a single project directory and have access to powerful tools for reading, searching, analyzing, and editing code.
## Core Principles
1. **Lazy Loading**: You don't have the full code in context. Use tools to fetch exactly what you need.
2. **Precision**: Always verify file paths and line numbers before making changes.
3. **Safety**: Confirm destructive operations. Never execute dangerous commands.
4. **Efficiency**: Minimize context usage. Request only necessary code sections.
## Available Tools
### Reading Tools
- \`get_lines\`: Get specific lines from a file
- \`get_function\`: Get a function by name
- \`get_class\`: Get a class by name
- \`get_structure\`: Get project directory structure
### Editing Tools (require confirmation)
- \`edit_lines\`: Replace specific lines in a file
- \`create_file\`: Create a new file
- \`delete_file\`: Delete a file
### Search Tools
- \`find_references\`: Find all usages of a symbol
- \`find_definition\`: Find where a symbol is defined
### Analysis Tools
- \`get_dependencies\`: Get files this file imports
- \`get_dependents\`: Get files that import this file
- \`get_complexity\`: Get complexity metrics
- \`get_todos\`: Find TODO/FIXME comments
### Git Tools
- \`git_status\`: Get repository status
- \`git_diff\`: Get uncommitted changes
- \`git_commit\`: Create a commit (requires confirmation)
### Run Tools
- \`run_command\`: Execute a shell command (security checked)
- \`run_tests\`: Run the test suite
## Response Guidelines
1. **Be concise**: Don't repeat information already in context.
2. **Show your work**: Explain what tools you're using and why.
3. **Verify before editing**: Always read the target code before modifying it.
4. **Handle errors gracefully**: If a tool fails, explain what went wrong and suggest alternatives.
## Code Editing Rules
1. Always use \`get_lines\` or \`get_function\` before \`edit_lines\`.
2. Provide exact line numbers for edits.
3. For large changes, break into multiple small edits.
4. After editing, suggest running tests if available.
## Safety Rules
1. Never execute commands that could harm the system.
2. Never expose sensitive data (API keys, passwords).
3. Always confirm file deletions and destructive git operations.
4. Stay within the project directory.
When you need to perform an action, use the appropriate tool. Think step by step about what information you need and which tools will provide it most efficiently.`
/**
* Build initial context from project structure and AST metadata.
* Returns a compact representation without actual code.
*/
export function buildInitialContext(
structure: ProjectStructure,
asts: Map<string, FileAST>,
metas?: Map<string, FileMeta>,
): string {
const sections: string[] = []
sections.push(formatProjectHeader(structure))
sections.push(formatDirectoryTree(structure))
sections.push(formatFileOverview(asts, metas))
return sections.join("\n\n")
}
/**
* Format project header section.
*/
function formatProjectHeader(structure: ProjectStructure): string {
const fileCount = String(structure.files.length)
const dirCount = String(structure.directories.length)
return `# Project: ${structure.name}
Root: ${structure.rootPath}
Files: ${fileCount} | Directories: ${dirCount}`
}
/**
* Format directory tree.
*/
function formatDirectoryTree(structure: ProjectStructure): string {
const lines: string[] = ["## Structure", ""]
const sortedDirs = [...structure.directories].sort()
for (const dir of sortedDirs) {
const depth = dir.split("/").length - 1
const indent = " ".repeat(depth)
const name = dir.split("/").pop() ?? dir
lines.push(`${indent}${name}/`)
}
return lines.join("\n")
}
/**
* Format file overview with AST summaries.
*/
function formatFileOverview(asts: Map<string, FileAST>, metas?: Map<string, FileMeta>): string {
const lines: string[] = ["## Files", ""]
const sortedPaths = [...asts.keys()].sort()
for (const path of sortedPaths) {
const ast = asts.get(path)
if (!ast) {
continue
}
const meta = metas?.get(path)
lines.push(formatFileSummary(path, ast, meta))
}
return lines.join("\n")
}
/**
* Format a single file's AST summary.
*/
function formatFileSummary(path: string, ast: FileAST, meta?: FileMeta): string {
const parts: string[] = []
if (ast.functions.length > 0) {
const names = ast.functions.map((f) => f.name).join(", ")
parts.push(`fn: ${names}`)
}
if (ast.classes.length > 0) {
const names = ast.classes.map((c) => c.name).join(", ")
parts.push(`class: ${names}`)
}
if (ast.interfaces.length > 0) {
const names = ast.interfaces.map((i) => i.name).join(", ")
parts.push(`interface: ${names}`)
}
if (ast.typeAliases.length > 0) {
const names = ast.typeAliases.map((t) => t.name).join(", ")
parts.push(`type: ${names}`)
}
const summary = parts.length > 0 ? ` [${parts.join(" | ")}]` : ""
const flags = formatFileFlags(meta)
return `- ${path}${summary}${flags}`
}
/**
* Format file metadata flags.
*/
function formatFileFlags(meta?: FileMeta): string {
if (!meta) {
return ""
}
const flags: string[] = []
if (meta.isHub) {
flags.push("hub")
}
if (meta.isEntryPoint) {
flags.push("entry")
}
if (meta.complexity.score > 70) {
flags.push("complex")
}
return flags.length > 0 ? ` (${flags.join(", ")})` : ""
}
/**
* Format line range for display.
*/
function formatLineRange(start: number, end: number): string {
return `[${String(start)}-${String(end)}]`
}
/**
* Format imports section.
*/
function formatImportsSection(ast: FileAST): string[] {
if (ast.imports.length === 0) {
return []
}
const lines = ["### Imports"]
for (const imp of ast.imports) {
lines.push(`- ${imp.name} from "${imp.from}" (${imp.type})`)
}
lines.push("")
return lines
}
/**
* Format exports section.
*/
function formatExportsSection(ast: FileAST): string[] {
if (ast.exports.length === 0) {
return []
}
const lines = ["### Exports"]
for (const exp of ast.exports) {
const defaultMark = exp.isDefault ? " (default)" : ""
lines.push(`- ${exp.kind} ${exp.name}${defaultMark}`)
}
lines.push("")
return lines
}
/**
* Format functions section.
*/
function formatFunctionsSection(ast: FileAST): string[] {
if (ast.functions.length === 0) {
return []
}
const lines = ["### Functions"]
for (const fn of ast.functions) {
const params = fn.params.map((p) => p.name).join(", ")
const asyncMark = fn.isAsync ? "async " : ""
const range = formatLineRange(fn.lineStart, fn.lineEnd)
lines.push(`- ${asyncMark}${fn.name}(${params}) ${range}`)
}
lines.push("")
return lines
}
/**
* Format classes section.
*/
function formatClassesSection(ast: FileAST): string[] {
if (ast.classes.length === 0) {
return []
}
const lines = ["### Classes"]
for (const cls of ast.classes) {
const ext = cls.extends ? ` extends ${cls.extends}` : ""
const impl = cls.implements.length > 0 ? ` implements ${cls.implements.join(", ")}` : ""
const range = formatLineRange(cls.lineStart, cls.lineEnd)
lines.push(`- ${cls.name}${ext}${impl} ${range}`)
for (const method of cls.methods) {
const vis = method.visibility === "public" ? "" : `${method.visibility} `
const methodRange = formatLineRange(method.lineStart, method.lineEnd)
lines.push(` - ${vis}${method.name}() ${methodRange}`)
}
}
lines.push("")
return lines
}
/**
* Format metadata section.
*/
function formatMetadataSection(meta: FileMeta): string[] {
const loc = String(meta.complexity.loc)
const score = String(meta.complexity.score)
const deps = String(meta.dependencies.length)
const dependents = String(meta.dependents.length)
return [
"### Metadata",
`- LOC: ${loc}`,
`- Complexity: ${score}/100`,
`- Dependencies: ${deps}`,
`- Dependents: ${dependents}`,
]
}
/**
* Build context for a specific file request.
*/
export function buildFileContext(path: string, ast: FileAST, meta?: FileMeta): string {
const lines: string[] = [`## ${path}`, ""]
lines.push(...formatImportsSection(ast))
lines.push(...formatExportsSection(ast))
lines.push(...formatFunctionsSection(ast))
lines.push(...formatClassesSection(ast))
if (meta) {
lines.push(...formatMetadataSection(meta))
}
return lines.join("\n")
}
/**
* Truncate context to fit within token budget.
*/
export function truncateContext(context: string, maxTokens: number): string {
const charsPerToken = 4
const maxChars = maxTokens * charsPerToken
if (context.length <= maxChars) {
return context
}
const truncated = context.slice(0, maxChars - 100)
const lastNewline = truncated.lastIndexOf("\n")
const remaining = String(context.length - lastNewline)
return `${truncated.slice(0, lastNewline)}\n\n... (truncated, ${remaining} chars remaining)`
}

View File

@@ -0,0 +1,511 @@
import type { ToolDef } from "../../domain/services/ILLMClient.js"
/**
* Tool definitions for ipuaro LLM.
* 18 tools across 6 categories: read, edit, search, analysis, git, run.
*/
/*
* =============================================================================
* Read Tools (4)
* =============================================================================
*/
export const GET_LINES_TOOL: ToolDef = {
name: "get_lines",
description:
"Get specific lines from a file. Returns the content with line numbers. " +
"If no range is specified, returns the entire file.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
{
name: "start",
type: "number",
description: "Start line number (1-based, inclusive)",
required: false,
},
{
name: "end",
type: "number",
description: "End line number (1-based, inclusive)",
required: false,
},
],
}
export const GET_FUNCTION_TOOL: ToolDef = {
name: "get_function",
description:
"Get a function's source code by name. Uses AST to find exact line range. " +
"Returns the function code with line numbers.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
{
name: "name",
type: "string",
description: "Function name to retrieve",
required: true,
},
],
}
export const GET_CLASS_TOOL: ToolDef = {
name: "get_class",
description:
"Get a class's source code by name. Uses AST to find exact line range. " +
"Returns the class code with line numbers.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
{
name: "name",
type: "string",
description: "Class name to retrieve",
required: true,
},
],
}
export const GET_STRUCTURE_TOOL: ToolDef = {
name: "get_structure",
description:
"Get project directory structure as a tree. " +
"If path is specified, shows structure of that subdirectory only.",
parameters: [
{
name: "path",
type: "string",
description: "Subdirectory path relative to project root (optional, defaults to root)",
required: false,
},
{
name: "depth",
type: "number",
description: "Maximum depth to traverse (default: unlimited)",
required: false,
},
],
}
/*
* =============================================================================
* Edit Tools (3) - All require confirmation
* =============================================================================
*/
export const EDIT_LINES_TOOL: ToolDef = {
name: "edit_lines",
description:
"Replace lines in a file with new content. Requires reading the file first. " +
"Will show diff and ask for confirmation before applying.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
{
name: "start",
type: "number",
description: "Start line number (1-based, inclusive) to replace",
required: true,
},
{
name: "end",
type: "number",
description: "End line number (1-based, inclusive) to replace",
required: true,
},
{
name: "content",
type: "string",
description: "New content to insert (can be multiple lines)",
required: true,
},
],
}
export const CREATE_FILE_TOOL: ToolDef = {
name: "create_file",
description:
"Create a new file with specified content. " +
"Will fail if file already exists. Will ask for confirmation.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
{
name: "content",
type: "string",
description: "File content",
required: true,
},
],
}
export const DELETE_FILE_TOOL: ToolDef = {
name: "delete_file",
description:
"Delete a file from the project. " +
"Will ask for confirmation. Previous content is saved to undo stack.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
],
}
/*
* =============================================================================
* Search Tools (2)
* =============================================================================
*/
export const FIND_REFERENCES_TOOL: ToolDef = {
name: "find_references",
description:
"Find all usages of a symbol across the codebase. " +
"Returns list of file paths, line numbers, and context.",
parameters: [
{
name: "symbol",
type: "string",
description: "Symbol name to search for (function, class, variable, etc.)",
required: true,
},
{
name: "path",
type: "string",
description: "Limit search to specific file or directory",
required: false,
},
],
}
export const FIND_DEFINITION_TOOL: ToolDef = {
name: "find_definition",
description:
"Find where a symbol is defined. " + "Returns file path, line number, and symbol type.",
parameters: [
{
name: "symbol",
type: "string",
description: "Symbol name to find definition for",
required: true,
},
],
}
/*
* =============================================================================
* Analysis Tools (4)
* =============================================================================
*/
export const GET_DEPENDENCIES_TOOL: ToolDef = {
name: "get_dependencies",
description:
"Get files that this file imports (internal dependencies). " +
"Returns list of imported file paths.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
],
}
export const GET_DEPENDENTS_TOOL: ToolDef = {
name: "get_dependents",
description:
"Get files that import this file (reverse dependencies). " +
"Returns list of file paths that depend on this file.",
parameters: [
{
name: "path",
type: "string",
description: "File path relative to project root",
required: true,
},
],
}
export const GET_COMPLEXITY_TOOL: ToolDef = {
name: "get_complexity",
description:
"Get complexity metrics for a file or the entire project. " +
"Returns LOC, nesting depth, cyclomatic complexity, and overall score.",
parameters: [
{
name: "path",
type: "string",
description: "File path (optional, defaults to all files sorted by complexity)",
required: false,
},
{
name: "limit",
type: "number",
description: "Max files to return when showing all (default: 10)",
required: false,
},
],
}
export const GET_TODOS_TOOL: ToolDef = {
name: "get_todos",
description:
"Find TODO, FIXME, HACK, and XXX comments in the codebase. " +
"Returns list with file paths, line numbers, and comment text.",
parameters: [
{
name: "path",
type: "string",
description: "Limit search to specific file or directory",
required: false,
},
{
name: "type",
type: "string",
description: "Filter by comment type",
required: false,
enum: ["TODO", "FIXME", "HACK", "XXX"],
},
],
}
/*
* =============================================================================
* Git Tools (3)
* =============================================================================
*/
export const GIT_STATUS_TOOL: ToolDef = {
name: "git_status",
description:
"Get current git repository status. " +
"Returns branch name, staged files, modified files, and untracked files.",
parameters: [],
}
export const GIT_DIFF_TOOL: ToolDef = {
name: "git_diff",
description:
"Get uncommitted changes (diff). " + "Shows what has changed but not yet committed.",
parameters: [
{
name: "path",
type: "string",
description: "Limit diff to specific file or directory",
required: false,
},
{
name: "staged",
type: "boolean",
description: "Show only staged changes (default: false, shows all)",
required: false,
},
],
}
export const GIT_COMMIT_TOOL: ToolDef = {
name: "git_commit",
description:
"Create a git commit with the specified message. " +
"Will ask for confirmation. Optionally stage specific files first.",
parameters: [
{
name: "message",
type: "string",
description: "Commit message",
required: true,
},
{
name: "files",
type: "array",
description: "Files to stage before commit (optional, defaults to all staged)",
required: false,
},
],
}
/*
* =============================================================================
* Run Tools (2)
* =============================================================================
*/
export const RUN_COMMAND_TOOL: ToolDef = {
name: "run_command",
description:
"Execute a shell command in the project directory. " +
"Commands are checked against blacklist/whitelist for security. " +
"Unknown commands require user confirmation.",
parameters: [
{
name: "command",
type: "string",
description: "Shell command to execute",
required: true,
},
{
name: "timeout",
type: "number",
description: "Timeout in milliseconds (default: 30000)",
required: false,
},
],
}
export const RUN_TESTS_TOOL: ToolDef = {
name: "run_tests",
description:
"Run the project's test suite. Auto-detects test runner (vitest, jest, npm test). " +
"Returns test results summary.",
parameters: [
{
name: "path",
type: "string",
description: "Run tests for specific file or directory",
required: false,
},
{
name: "filter",
type: "string",
description: "Filter tests by name pattern",
required: false,
},
{
name: "watch",
type: "boolean",
description: "Run in watch mode (default: false)",
required: false,
},
],
}
/*
* =============================================================================
* Tool Collection
* =============================================================================
*/
/**
* All read tools (no confirmation required).
*/
export const READ_TOOLS: ToolDef[] = [
GET_LINES_TOOL,
GET_FUNCTION_TOOL,
GET_CLASS_TOOL,
GET_STRUCTURE_TOOL,
]
/**
* All edit tools (require confirmation).
*/
export const EDIT_TOOLS: ToolDef[] = [EDIT_LINES_TOOL, CREATE_FILE_TOOL, DELETE_FILE_TOOL]
/**
* All search tools (no confirmation required).
*/
export const SEARCH_TOOLS: ToolDef[] = [FIND_REFERENCES_TOOL, FIND_DEFINITION_TOOL]
/**
* All analysis tools (no confirmation required).
*/
export const ANALYSIS_TOOLS: ToolDef[] = [
GET_DEPENDENCIES_TOOL,
GET_DEPENDENTS_TOOL,
GET_COMPLEXITY_TOOL,
GET_TODOS_TOOL,
]
/**
* All git tools (git_commit requires confirmation).
*/
export const GIT_TOOLS: ToolDef[] = [GIT_STATUS_TOOL, GIT_DIFF_TOOL, GIT_COMMIT_TOOL]
/**
* All run tools (run_command may require confirmation).
*/
export const RUN_TOOLS: ToolDef[] = [RUN_COMMAND_TOOL, RUN_TESTS_TOOL]
/**
* All 18 tool definitions.
*/
export const ALL_TOOLS: ToolDef[] = [
...READ_TOOLS,
...EDIT_TOOLS,
...SEARCH_TOOLS,
...ANALYSIS_TOOLS,
...GIT_TOOLS,
...RUN_TOOLS,
]
/**
* Tools that require user confirmation before execution.
*/
export const CONFIRMATION_TOOLS = new Set([
"edit_lines",
"create_file",
"delete_file",
"git_commit",
])
/**
* Check if a tool requires confirmation.
*/
export function requiresConfirmation(toolName: string): boolean {
return CONFIRMATION_TOOLS.has(toolName)
}
/**
* Get tool definition by name.
*/
export function getToolDef(name: string): ToolDef | undefined {
return ALL_TOOLS.find((t) => t.name === name)
}
/**
* Get tool definitions by category.
*/
export function getToolsByCategory(category: string): ToolDef[] {
switch (category) {
case "read":
return READ_TOOLS
case "edit":
return EDIT_TOOLS
case "search":
return SEARCH_TOOLS
case "analysis":
return ANALYSIS_TOOLS
case "git":
return GIT_TOOLS
case "run":
return RUN_TOOLS
default:
return []
}
}