mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-18 12:03:03 +00:00
- Add setActiveTools() to ExtensionAPI for dynamic tool management - Extensions can now override, wrap, or disable built-in tools - Add tool-override.ts example demonstrating the pattern - Update documentation for tool override capabilities
307 lines
9.9 KiB
TypeScript
307 lines
9.9 KiB
TypeScript
/**
|
|
* System prompt construction and project context loading
|
|
*/
|
|
|
|
import chalk from "chalk";
|
|
import { existsSync, readFileSync } from "fs";
|
|
import { join, resolve } from "path";
|
|
import { getAgentDir, getDocsPath, getExamplesPath, getReadmePath } from "../config.js";
|
|
import type { SkillsSettings } from "./settings-manager.js";
|
|
import { formatSkillsForPrompt, loadSkills, type Skill } from "./skills.js";
|
|
import type { ToolName } from "./tools/index.js";
|
|
|
|
/** Tool descriptions for system prompt */
|
|
const toolDescriptions: Record<ToolName, string> = {
|
|
read: "Read file contents",
|
|
bash: "Execute bash commands (ls, grep, find, etc.)",
|
|
edit: "Make surgical edits to files (find exact text and replace)",
|
|
write: "Create or overwrite files",
|
|
grep: "Search file contents for patterns (respects .gitignore)",
|
|
find: "Find files by glob pattern (respects .gitignore)",
|
|
ls: "List directory contents",
|
|
};
|
|
|
|
/** Resolve input as file path or literal string */
|
|
export function resolvePromptInput(input: string | undefined, description: string): string | undefined {
|
|
if (!input) {
|
|
return undefined;
|
|
}
|
|
|
|
if (existsSync(input)) {
|
|
try {
|
|
return readFileSync(input, "utf-8");
|
|
} catch (error) {
|
|
console.error(chalk.yellow(`Warning: Could not read ${description} file ${input}: ${error}`));
|
|
return input;
|
|
}
|
|
}
|
|
|
|
return input;
|
|
}
|
|
|
|
/** Look for AGENTS.md or CLAUDE.md in a directory (prefers AGENTS.md) */
|
|
function loadContextFileFromDir(dir: string): { path: string; content: string } | null {
|
|
const candidates = ["AGENTS.md", "CLAUDE.md"];
|
|
for (const filename of candidates) {
|
|
const filePath = join(dir, filename);
|
|
if (existsSync(filePath)) {
|
|
try {
|
|
return {
|
|
path: filePath,
|
|
content: readFileSync(filePath, "utf-8"),
|
|
};
|
|
} catch (error) {
|
|
console.error(chalk.yellow(`Warning: Could not read ${filePath}: ${error}`));
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export interface LoadContextFilesOptions {
|
|
/** Working directory to start walking up from. Default: process.cwd() */
|
|
cwd?: string;
|
|
/** Agent config directory for global context. Default: from getAgentDir() */
|
|
agentDir?: string;
|
|
}
|
|
|
|
/**
|
|
* Load all project context files in order:
|
|
* 1. Global: agentDir/AGENTS.md or CLAUDE.md
|
|
* 2. Parent directories (top-most first) down to cwd
|
|
* Each returns {path, content} for separate messages
|
|
*/
|
|
export function loadProjectContextFiles(
|
|
options: LoadContextFilesOptions = {},
|
|
): Array<{ path: string; content: string }> {
|
|
const resolvedCwd = options.cwd ?? process.cwd();
|
|
const resolvedAgentDir = options.agentDir ?? getAgentDir();
|
|
|
|
const contextFiles: Array<{ path: string; content: string }> = [];
|
|
const seenPaths = new Set<string>();
|
|
|
|
// 1. Load global context from agentDir
|
|
const globalContext = loadContextFileFromDir(resolvedAgentDir);
|
|
if (globalContext) {
|
|
contextFiles.push(globalContext);
|
|
seenPaths.add(globalContext.path);
|
|
}
|
|
|
|
// 2. Walk up from cwd to root, collecting all context files
|
|
const ancestorContextFiles: Array<{ path: string; content: string }> = [];
|
|
|
|
let currentDir = resolvedCwd;
|
|
const root = resolve("/");
|
|
|
|
while (true) {
|
|
const contextFile = loadContextFileFromDir(currentDir);
|
|
if (contextFile && !seenPaths.has(contextFile.path)) {
|
|
// Add to beginning so we get top-most parent first
|
|
ancestorContextFiles.unshift(contextFile);
|
|
seenPaths.add(contextFile.path);
|
|
}
|
|
|
|
// Stop if we've reached root
|
|
if (currentDir === root) break;
|
|
|
|
// Move up one directory
|
|
const parentDir = resolve(currentDir, "..");
|
|
if (parentDir === currentDir) break; // Safety check
|
|
currentDir = parentDir;
|
|
}
|
|
|
|
// Add ancestor files in order (top-most → cwd)
|
|
contextFiles.push(...ancestorContextFiles);
|
|
|
|
return contextFiles;
|
|
}
|
|
|
|
export interface BuildSystemPromptOptions {
|
|
/** Custom system prompt (replaces default). */
|
|
customPrompt?: string;
|
|
/** Tools to include in prompt. Default: [read, bash, edit, write] */
|
|
selectedTools?: ToolName[];
|
|
/** Text to append to system prompt. */
|
|
appendSystemPrompt?: string;
|
|
/** Skills settings for discovery. */
|
|
skillsSettings?: SkillsSettings;
|
|
/** Working directory. Default: process.cwd() */
|
|
cwd?: string;
|
|
/** Agent config directory. Default: from getAgentDir() */
|
|
agentDir?: string;
|
|
/** Pre-loaded context files (skips discovery if provided). */
|
|
contextFiles?: Array<{ path: string; content: string }>;
|
|
/** Pre-loaded skills (skips discovery if provided). */
|
|
skills?: Skill[];
|
|
}
|
|
|
|
/** Build the system prompt with tools, guidelines, and context */
|
|
export function buildSystemPrompt(options: BuildSystemPromptOptions = {}): string {
|
|
const {
|
|
customPrompt,
|
|
selectedTools,
|
|
appendSystemPrompt,
|
|
skillsSettings,
|
|
cwd,
|
|
agentDir,
|
|
contextFiles: providedContextFiles,
|
|
skills: providedSkills,
|
|
} = options;
|
|
const resolvedCwd = cwd ?? process.cwd();
|
|
const resolvedCustomPrompt = resolvePromptInput(customPrompt, "system prompt");
|
|
const resolvedAppendPrompt = resolvePromptInput(appendSystemPrompt, "append system prompt");
|
|
|
|
const now = new Date();
|
|
const dateTime = now.toLocaleString("en-US", {
|
|
weekday: "long",
|
|
year: "numeric",
|
|
month: "long",
|
|
day: "numeric",
|
|
hour: "2-digit",
|
|
minute: "2-digit",
|
|
second: "2-digit",
|
|
timeZoneName: "short",
|
|
});
|
|
|
|
const appendSection = resolvedAppendPrompt ? `\n\n${resolvedAppendPrompt}` : "";
|
|
|
|
// Resolve context files: use provided or discover
|
|
const contextFiles = providedContextFiles ?? loadProjectContextFiles({ cwd: resolvedCwd, agentDir });
|
|
|
|
// Resolve skills: use provided or discover
|
|
const skills =
|
|
providedSkills ??
|
|
(skillsSettings?.enabled !== false ? loadSkills({ ...skillsSettings, cwd: resolvedCwd, agentDir }).skills : []);
|
|
|
|
if (resolvedCustomPrompt) {
|
|
let prompt = resolvedCustomPrompt;
|
|
|
|
if (appendSection) {
|
|
prompt += appendSection;
|
|
}
|
|
|
|
// Append project context files
|
|
if (contextFiles.length > 0) {
|
|
prompt += "\n\n# Project Context\n\n";
|
|
prompt += "The following project context files have been loaded:\n\n";
|
|
for (const { path: filePath, content } of contextFiles) {
|
|
prompt += `## ${filePath}\n\n${content}\n\n`;
|
|
}
|
|
}
|
|
|
|
// Append skills section (only if read tool is available)
|
|
const customPromptHasRead = !selectedTools || selectedTools.includes("read");
|
|
if (customPromptHasRead && skills.length > 0) {
|
|
prompt += formatSkillsForPrompt(skills);
|
|
}
|
|
|
|
// Add date/time and working directory last
|
|
prompt += `\nCurrent date and time: ${dateTime}`;
|
|
prompt += `\nCurrent working directory: ${resolvedCwd}`;
|
|
|
|
return prompt;
|
|
}
|
|
|
|
// Get absolute paths to documentation and examples
|
|
const readmePath = getReadmePath();
|
|
const docsPath = getDocsPath();
|
|
const examplesPath = getExamplesPath();
|
|
|
|
// Build tools list based on selected tools
|
|
const tools = selectedTools || (["read", "bash", "edit", "write"] as ToolName[]);
|
|
const toolsList = tools.length > 0 ? tools.map((t) => `- ${t}: ${toolDescriptions[t]}`).join("\n") : "(none)";
|
|
|
|
// Build guidelines based on which tools are actually available
|
|
const guidelinesList: string[] = [];
|
|
|
|
const hasBash = tools.includes("bash");
|
|
const hasEdit = tools.includes("edit");
|
|
const hasWrite = tools.includes("write");
|
|
const hasGrep = tools.includes("grep");
|
|
const hasFind = tools.includes("find");
|
|
const hasLs = tools.includes("ls");
|
|
const hasRead = tools.includes("read");
|
|
|
|
// Bash without edit/write = read-only bash mode
|
|
if (hasBash && !hasEdit && !hasWrite) {
|
|
guidelinesList.push(
|
|
"Use bash ONLY for read-only operations (git log, gh issue view, curl, etc.) - do NOT modify any files",
|
|
);
|
|
}
|
|
|
|
// File exploration guidelines
|
|
if (hasBash && !hasGrep && !hasFind && !hasLs) {
|
|
guidelinesList.push("Use bash for file operations like ls, grep, find");
|
|
} else if (hasBash && (hasGrep || hasFind || hasLs)) {
|
|
guidelinesList.push("Prefer grep/find/ls tools over bash for file exploration (faster, respects .gitignore)");
|
|
}
|
|
|
|
// Read before edit guideline
|
|
if (hasRead && hasEdit) {
|
|
guidelinesList.push("Use read to examine files before editing. You must use this tool instead of cat or sed.");
|
|
}
|
|
|
|
// Edit guideline
|
|
if (hasEdit) {
|
|
guidelinesList.push("Use edit for precise changes (old text must match exactly)");
|
|
}
|
|
|
|
// Write guideline
|
|
if (hasWrite) {
|
|
guidelinesList.push("Use write only for new files or complete rewrites");
|
|
}
|
|
|
|
// Output guideline (only when actually writing/executing)
|
|
if (hasEdit || hasWrite) {
|
|
guidelinesList.push(
|
|
"When summarizing your actions, output plain text directly - do NOT use cat or bash to display what you did",
|
|
);
|
|
}
|
|
|
|
// Always include these
|
|
guidelinesList.push("Be concise in your responses");
|
|
guidelinesList.push("Show file paths clearly when working with files");
|
|
|
|
const guidelines = guidelinesList.map((g) => `- ${g}`).join("\n");
|
|
|
|
let prompt = `You are an expert coding assistant. You help users with coding tasks by reading files, executing commands, editing code, and writing new files.
|
|
|
|
Available tools:
|
|
${toolsList}
|
|
|
|
In addition to the tools above, you may have access to other custom tools depending on the project.
|
|
|
|
Guidelines:
|
|
${guidelines}
|
|
|
|
Documentation:
|
|
- Main documentation: ${readmePath}
|
|
- Additional docs: ${docsPath}
|
|
- Examples: ${examplesPath} (extensions, custom tools, SDK)
|
|
- When asked to create: custom models/providers (README.md), extensions (docs/extensions.md, examples/extensions/), themes (docs/theme.md), skills (docs/skills.md), TUI components (docs/tui.md - has copy-paste patterns)
|
|
- Always read the doc, examples, AND follow .md cross-references before implementing`;
|
|
|
|
if (appendSection) {
|
|
prompt += appendSection;
|
|
}
|
|
|
|
// Append project context files
|
|
if (contextFiles.length > 0) {
|
|
prompt += "\n\n# Project Context\n\n";
|
|
prompt += "The following project context files have been loaded:\n\n";
|
|
for (const { path: filePath, content } of contextFiles) {
|
|
prompt += `## ${filePath}\n\n${content}\n\n`;
|
|
}
|
|
}
|
|
|
|
// Append skills section (only if read tool is available)
|
|
if (hasRead && skills.length > 0) {
|
|
prompt += formatSkillsForPrompt(skills);
|
|
}
|
|
|
|
// Add date/time and working directory last
|
|
prompt += `\nCurrent date and time: ${dateTime}`;
|
|
prompt += `\nCurrent working directory: ${resolvedCwd}`;
|
|
|
|
return prompt;
|
|
}
|