Skip to content

Gaunt Sloth Documentation

Select theme

Getting Started
- Overview
- Quickstart
Guides & Recipes
Configuration
Reference
- Commands
- Debug dump
Migrating to 2.0
Contributing
API
- @gaunt-sloth/agent
  - builtInToolsConfig.js
  - core/debugCapture.js
    References
    extractDebugRequestExtras
  - core/deepAgentPermissions.js
    References
    FilesystemPermission
  - core/gthAcpServer.js
  - core/GthDeepAgent.js
  - core/gthDeepAgentFactory.js
  - core/resolveAgentFactory.js
  - core/subagentProfiles.js
  - GthDevToolkit
  - index.js
    References
    A2AClientConfig
    A2AClientWrapper
    A2AMessageResult
    A2ASendContext
    aiignoreToPermissions
    allowDirsToPermissions
    AVAILABLE_BUILT_IN_TOOLS
    buildPermissions
    convertMessage
    convertMessages
    createA2AAgentTool
    createAuthProviderAndAuthenticate
    createInteractiveSession
    createOAuthRedirectServer
    createResolvers
    FILESYSTEM_TOOL_NAMES
    filesystemModeToPermissions
    FilesystemPermission
    getDefaultTools
    GthDeepAgent
    gthDeepAgentFactory
    GthDeepAgentParams
    guardFilesystemBackend
    OAuthClientProviderImpl
    PermissionConfigSlice
    prepareMcpTools
    RealpathGuardOptions
    resolveAgentFactory
    resolveMiddleware
    SessionConfig
    startAcpServer
    StartAcpServerOptions
    startAgUiServer
  - mcp/OAuthClientProviderImpl.js
  - mcp/tlsTrust.js
  - middleware/binaryContentInjectionMiddleware.js
  - middleware/frontendImageInjectionMiddleware.js
  - middleware/registry.js
  - middleware/types.js
  - modules/a2a/A2AClientWrapper.js
  - modules/acpModule.js
  - modules/apiAgUiModule.js
  - modules/interactiveSessionModule.js
  - modules/slashCommands.js
  - resolvers.js
  - tools/A2AAgentTool.js
  - tools/binaryUtils.js
  - tools/gthChecklistTool.js
  - tools/GthCustomToolkit.js
  - tools/GthFileSystemToolkit.js
  - tools/gthGrepTool.js
  - tools/gthStatusUpdateTool.js
  - tools/gthWebFetchTool.js
  - tools/McpResourceTool.js
  - tools/shell/env.js
  - tools/shell/hardline.js
  - tools/shell/outputBuffer.js
  - tools/shell/workDir.js
  - tools/showA2UISurfaceTool.js
  - utils/mcpAuthError.js
  - utils/mcpUtils.js
- @gaunt-sloth/core
  - config
    References
    AllowlistCounts
    applyRungAwareToolDescriptions
    APPROVAL_RUNG_DESCRIPTIONS
    APPROVAL_RUNG_LABELS
    APPROVAL_RUNGS
    ApprovalEntry
    ApprovalEntryType
    ApprovalHintPattern
    ApprovalMatcher
    ApprovalRung
    ApprovalsConfig
    ApprovalsObjectConfig
    availableDefaultConfigs
    BinaryFormatConfig
    BinaryFormatType
    buildProfileScaffold
    BUILT_IN_TOOL_ACCESS
    BUILT_IN_TOOL_SUMMARIES
    BuiltInToolAccess
    BuiltInToolConfig
    BuiltInToolsConfig
    BuiltInToolsSetting
    CommandLineConfigOverrides
    CommandToolingConfig
    ConfigLayerValidationReport
    ConfigType
    ConfigValidationReport
    ConsoleLevelInput
    createNamedProfile
    CreateProfileResult
    CustomCommandConfig
    CustomCommandParameter
    CustomToolsConfig
    DEFAULT_APPROVAL_RUNG
    DEFAULT_CONFIG
    DEFAULT_SCAFFOLD_MODEL
    DEFAULT_SCAFFOLD_PROVIDER
    DescribableTool
    describeGrantedBuiltInTools
    DEV_COMMAND_TOOL_NAMES
    DEV_TOOL_NAMES
    findProjectConfigPath
    getEffectiveDevToolsConfig
    getRungToolDescriptionSuffix
    getShellMaxOutputBytes
    getShellTimeoutMs
    GrantedToolSummary
    GthConfig
    GthDevToolsConfig
    hasAnyConfig
    hasProjectConfig
    initConfig
    isApprovalRung
    isBuiltInToolEntryEnabled
    isGrantedAtRung
    isRatedRung
    isShellToolEnabled
    LLMConfig
    loadGlobalRawConfig
    McpAnnotationTrustChange
    McpAnnotationTrustView
    McpApprovalsConfig
    McpServerAnnotationTrust
    McpServerApprovalsConfig
    McpToolApprovalEntry
    normalizeBuiltInTools
    PrCommandConfig
    PROFILE_NAME_RE
    ProfileScaffoldSeed
    PromptsConfig
    PromptSegmentConfig
    PromptSegmentName
    PromptSegmentSetting
    RatingConfig
    RawGthConfig
    resolveApprovals
    resolveConfig
    resolveConfigExtends
    ResolvedApprovals
    resolveIdentityProfileConfigPath
    resolveProfileConfigPath
    resolveShellApprovalGate
    RUNG_TOOL_DESCRIPTION_SUFFIXES
    ServerTool
    SHELL_DEFAULT_MAX_OUTPUT_BYTES
    SHELL_DEFAULT_TIMEOUT_MS
    SHELL_TOOL_NAME
    ShellApprovalEntry
    ShellApprovalGateDecision
    ShellApprovalGateNotice
    stripRungToolDescriptionSuffix
    SubagentProfileSpec
    TOOL_ANNOTATION_HINTS
    ToolAnnotationHint
    ToolApprovalEntry
    tryJsonConfig
    validateConfig
    validateProfileName
    ValidationCheck
  - config/colour
  - config/defaults
  - config/jsonc
  - config/loader
  - config/mouse
  - config/profiles
  - config/schema
  - config/shell-policy
  - config/tool-descriptions
  - config/types
  - constants
  - core/approvals/annotations
  - core/approvals/grants
  - core/approvals/matcher
  - core/approvals/mcpSubjects
  - core/approvals/toolAnnotationSources
  - core/approvals/toolHost
  - core/debugCapture
  - core/GthAbstractAgent
  - core/GthAgentRunner
  - core/GthLangChainAgent
    References
    AgentStreamEvent
  - core/gthLeanAgentFactory
  - core/launchBanner
  - core/plainToolIndication
  - core/refusal
  - core/runStats
  - core/shell/approvalStop
  - core/shell/arity
  - core/shell/denylist
  - core/shell/normalize
  - core/shell/openWorld
  - core/shell/rater
  - core/shell/raterModel
  - core/shell/rejection
  - core/shell/ShellCommandFailedError
  - core/toolCallRepair
    References
    MAX_TEXT_EMITTED_TOOL_CALL_PAYLOAD_BYTES
    parseStandalonePlainTextToolCallBlocks
    PlainTextToolCallBlock
    PlainTextToolCallParseOptions
    promoteTextEmittedToolCallMessage
    textToNativeToolCalls
    TextToolCallRepairOptions
  - core/toolCallRepair/grammar
  - core/toolCallRepair/payload
  - core/toolCallRepair/promote
    References
    MAX_TEXT_EMITTED_TOOL_CALL_PAYLOAD_BYTES
  - core/toolDisplay
  - core/toolOutputChannel
  - core/types
  - history/historyFormat
  - history/historyStore
  - history/recordSession
  - index
    References
    AgentResolvers
    AgentStreamEvent
    AIIGNORE_FILE
    AllowlistCounts
    applyRungAwareToolDescriptions
    APPROVAL_RUNG_DESCRIPTIONS
    APPROVAL_RUNG_LABELS
    APPROVAL_RUNGS
    ApprovalEntry
    ApprovalEntryType
    ApprovalHintPattern
    ApprovalMatcher
    ApprovalRung
    ApprovalsConfig
    ApprovalsObjectConfig
    availableDefaultConfigs
    BinaryFormatConfig
    BinaryFormatType
    buildInitConfigContent
    buildModelList
    buildProfileScaffold
    BUILT_IN_TOOL_ACCESS
    BUILT_IN_TOOL_SUMMARIES
    BuiltInToolAccess
    BuiltInToolConfig
    BuiltInToolsConfig
    BuiltInToolsSetting
    CommandLineConfigOverrides
    CommandToolingConfig
    CONFIG_SCHEMA_POINTER
    ConfigLayerValidationReport
    ConfigType
    ConfigValidationReport
    ConsoleLevelInput
    ConversationMeta
    ConversationSummary
    createNamedProfile
    CreateProfileResult
    CustomCommandConfig
    CustomCommandParameter
    CustomToolsConfig
    DEFAULT_APPROVAL_RUNG
    DEFAULT_COMMIT_CO_AUTHOR_EMAIL
    DEFAULT_COMMIT_CO_AUTHOR_NAME
    DEFAULT_CONFIG
    DEFAULT_OLLAMA_HOST
    DEFAULT_SCAFFOLD_MODEL
    DEFAULT_SCAFFOLD_PROVIDER
    DescribableTool
    describeGrantedBuiltInTools
    DetectedProvider
    detectProviders
    DEV_COMMAND_TOOL_NAMES
    DEV_TOOL_NAMES
    discoverModels
    discoverModelsWithProvenance
    DiscoveryConfig
    DiscoveryKind
    findApiKeyEnvVar
    findProjectConfigPath
    formatConversationList
    formatConversationThread
    formatInsightsSummary
    formatSearchResults
    getCuratedFallbackModel
    getEffectiveDevToolsConfig
    getRungToolDescriptionSuffix
    getShellMaxOutputBytes
    getShellTimeoutMs
    GrantedToolSummary
    GSLOTH_AUTH
    GSLOTH_BACKSTORY
    GSLOTH_CHAT_PROMPT
    GSLOTH_CODE_PROMPT
    GSLOTH_DIR
    GSLOTH_EXEC_PROMPT
    GSLOTH_SETTINGS_DIR
    GSLOTH_SYSTEM_PROMPT
    GthAgentFactory
    GthAgentInterface
    GthCommand
    GthCompiledGraph
    GthConfig
    GthDevToolsConfig
    gthLeanAgentFactory
    GthRunStats
    GthToolResult
    hasAnyConfig
    hasProjectConfig
    HISTORY_DB_FILENAME
    HistoryConfigView
    HistoryInsights
    HistoryStore
    initConfig
    INTERACTIVE_MODEL_FETCH_TIMEOUT_MS
    isApprovalRung
    isBuiltInToolEntryEnabled
    isGrantedAtRung
    isRatedRung
    isShellToolEnabled
    listModels
    LLMConfig
    loadGlobalRawConfig
    MCP_TOOL_NAME_PREFIX
    McpAnnotationTrustChange
    McpAnnotationTrustView
    McpApprovalsConfig
    McpConnectionFailure
    McpServerAnnotationTrust
    McpServerApprovalsConfig
    McpServerInstruction
    McpToolApprovalEntry
    Message
    MiddlewareCleanup
    MiddlewareResolver
    ModelDiscoveryOptions
    ModelDiscoveryResult
    ModelDiscoveryStatus
    ModelInfo
    normalizeBuiltInTools
    openConversationSafe
    openHistoryStore
    OpenHistoryStoreOptions
    PendingToolInterrupt
    PrCommandConfig
    PROFILE_NAME_RE
    ProfileScaffoldSeed
    PROJECT_GUIDELINES
    PROJECT_REVIEW_INSTRUCTIONS
    PromptsConfig
    PromptSegmentConfig
    PromptSegmentName
    PromptSegmentSetting
    PROVIDER_DESCRIPTORS
    ProviderDescriptor
    ProviderId
    RatingConfig
    RawGthConfig
    recordSessionSafe
    resolveApprovals
    resolveConfig
    resolveConfigExtends
    ResolvedApprovals
    resolveHistoryDbPath
    resolveIdentityProfileConfigPath
    resolveInitModel
    resolveProfileConfigPath
    resolveShellApprovalGate
    RUNG_TOOL_DESCRIPTION_SUFFIXES
    ServerTool
    SessionRecord
    SessionSearchResult
    SHELL_ALLOWLIST_FILE
    SHELL_DEFAULT_MAX_OUTPUT_BYTES
    SHELL_DEFAULT_TIMEOUT_MS
    SHELL_TOOL_NAME
    ShellApprovalEntry
    ShellApprovalGateDecision
    ShellApprovalGateNotice
    StatusLevel
    StatusUpdateCallback
    stripRungToolDescriptionSuffix
    SubagentProfileSpec
    toFtsMatchQuery
    TOOL_ANNOTATION_HINTS
    ToolAnnotationHint
    ToolApprovalCallback
    ToolApprovalDecision
    ToolApprovalEntry
    ToolApprovalScope
    ToolsCleanup
    ToolsResolver
    tryJsonConfig
    USER_PROJECT_CONFIG_JS
    USER_PROJECT_CONFIG_JSON
    USER_PROJECT_CONFIG_JSONC
    USER_PROJECT_CONFIG_MJS
    USER_PROJECT_CONFIG_TS
    validateConfig
    validateProfileName
    ValidationCheck
  - providers/anthropic
  - providers/deepseek
  - providers/fake
  - providers/geminiSchemaSanitizer
  - providers/google-genai
  - providers/groq
  - providers/huggingface
  - providers/modelCatalog
  - providers/modelDiscovery
  - providers/ollama
  - providers/openai
  - providers/openrouter
  - providers/vertexai
  - providers/xai
  - runtime/askStructured
  - runtime/conversation
  - runtime/singleShot
  - state/artifactStore
  - utils/aiignoreUtils
  - utils/binaryOutputUtils
  - utils/consoleUtils
  - utils/crashHandler
  - utils/debugDump
  - utils/debugUtils
  - utils/fileUtils
  - utils/globalConfigUtils
  - utils/llmUtils
  - utils/ProgressIndicator
  - utils/redactSecrets
  - utils/stringUtils
  - utils/systemPromptNotes
  - utils/systemUtils
  - utils/toolMatching
  - utils/vertexaiUtils
- @gaunt-sloth/review
  - commands/commandUtils
  - helpers/jira/jiraClient
  - index
    References
    CONTENT_SOURCES
    ContentSourceType
    get
    getContentFromSource
    getRequirementsFromSource
    getReviewPreamble
    ghReadFileImpl
    GTH_GH_READ_FILE_TOOL_NAME
    PrRepoContext
    REQUIREMENTS_SOURCES
    RequirementSourceType
    resolvePrRepoContext
    review
    ReviewContext
  - middleware/reviewRateMiddleware
  - modules/reviewModule
  - modules/types
  - sources/fileSource
  - sources/ghIssueSource
  - sources/ghPrDiffSource
  - sources/ghPrViewSource
  - sources/gitDiffSource
  - sources/jiraIssueLegacySource
  - sources/jiraIssueSource
  - sources/textSource
  - sources/types
  - tools/ghReadFileTool
  - utils/fileUtils
v1.x docs (legacy)

Select theme

On this page

Overview

On this page

Overview

CustomToolsConfig

CustomToolsConfig = Record<string, CustomCommandConfig>

Defined in: core/dist/config/types.d.ts:573