@compilr-dev/sdk 0.1.27 → 0.2.0

package/dist/team/tool-config.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Tool Configuration for Custom Agents
+ *
+ * Defines tool groups, profiles, and helpers for configuring
+ * which tools a custom agent can access.
+ *
+ * Tool names are defined as string constants below. These cover all tools
+ * from @compilr-dev/agents, @compilr-dev/agents-coding, and platform tools.
+ */
+export type ToolProfile = 'full' | 'read-only' | 'developer' | 'security' | 'docs' | 'devops' | 'qa' | 'architect' | 'planner' | 'analyst' | 'custom';
+export interface ToolConfig {
+    /** Tool profile (predefined set) */
+    profile: ToolProfile;
+    /** Custom groups when profile === 'custom' */
+    customGroups?: string[];
+    /** Override flag: force read-only on any profile */
+    readOnly?: boolean;
+}
+export type ToolTier = 'direct' | 'meta';
+export interface ToolGroup {
+    /** Human-readable label */
+    label: string;
+    /** Tool names in this group */
+    tools: string[];
+    /** Whether this group is read-only (no side effects) */
+    readOnly: boolean;
+    /** Tier: direct tools vs meta-registry tools */
+    tier: ToolTier;
+    /** Optional note about the group */
+    note?: string;
+}
+/**
+ * All tool groups organized by functionality.
+ * These cover all ~50 tools in the CLI.
+ *
+ * Tool names use TOOL_NAMES constants for consistency.
+ */
+export declare const TOOL_GROUPS: Record<string, ToolGroup>;
+/**
+ * Predefined tool profiles mapping profile name to included groups.
+ */
+export declare const TOOL_PROFILES: Record<ToolProfile, string[]>;
+export interface ProfileInfo {
+    label: string;
+    description: string;
+    isReadOnly: boolean;
+}
+export declare const PROFILE_INFO: Record<ToolProfile, ProfileInfo>;
+/**
+ * Get all tool names for a given profile.
+ *
+ * @param profile - The tool profile
+ * @param customGroups - Custom groups (when profile is 'custom')
+ * @returns Array of tool names
+ */
+export declare function getToolsForProfile(profile: ToolProfile, customGroups?: string[]): string[];
+/**
+ * Get all group IDs for a profile.
+ */
+export declare function getGroupsForProfile(profile: ToolProfile): string[];
+/**
+ * Get the profile that best matches a set of tools.
+ * Used for displaying current config in UI.
+ */
+export declare function detectProfileFromTools(tools: string[]): ToolProfile;
+/**
+ * Check if a profile only includes read-only groups.
+ */
+export declare function isProfileReadOnly(profile: ToolProfile, customGroups?: string[]): boolean;
+/**
+ * Get all available group IDs.
+ */
+export declare function getAllGroupIds(): string[];
+/**
+ * Get group info by ID.
+ */
+export declare function getGroupInfo(groupId: string): ToolGroup | undefined;
+/**
+ * Get groups organized by tier.
+ */
+export declare function getGroupsByTier(): {
+    direct: string[];
+    meta: string[];
+};
+/**
+ * Create a default tool config (full access).
+ */
+export declare function createDefaultToolConfig(): ToolConfig;
+/**
+ * Validate a tool config.
+ */
+export declare function validateToolConfig(config: Partial<ToolConfig>): {
+    valid: boolean;
+    error?: string;
+};
+/**
+ * Generate self-awareness text for system prompt.
+ * Tells the agent about its tool limitations.
+ */
+export declare function generateToolAwarenessPrompt(config: ToolConfig): string;
+/**
+ * Generate delegation guidance for the coordinator.
+ * Explains how to use the delegate tool effectively.
+ */
+export declare function generateCoordinatorGuidance(): string;
+/**
+ * Generate delegation suggestion guidance for specialists.
+ * Explains how to suggest other specialists when appropriate.
+ */
+export declare function generateSpecialistGuidance(role: string): string;