import React from 'react'; import CodeBlock from '@theme/CodeBlock'; import Admonition from '@theme/Admonition'; interface EnvVar { key: string; value: string; } interface CLIExtensionInstructionsProps { name: string; description: string; type?: 'stdio' | 'http'; command?: string; // Only for stdio url?: string; // For http timeout?: number; envVars?: EnvVar[]; // For stdio: environment variables, for http: headers infoNote?: string; commandNote?: React.ReactNode; // Note to display for command/URL step } export default function CLIExtensionInstructions({ name, description, type = 'stdio', command, url, timeout = 300, envVars = [], infoNote, commandNote, }: CLIExtensionInstructionsProps) { const hasEnvVars = envVars.length > 0; const isHttp = type === 'http'; const isRemote = isHttp; // Determine last-step prompt text const lastStepText = isHttp ? 'Would you like to add custom headers?' : 'Would you like to add environment variables?'; const lastStepInstruction = hasEnvVars ? `Add ${isHttp ? 'custom header' : 'environment variable'}${envVars.length > 1 ? 's' : ''} for ${name}` : isHttp ? 'Choose No when asked to add custom headers.' : 'Choose No when asked to add environment variables.'; return (

Run the configure command:

{`goose configure`}

Choose to add a{' '} {isHttp ? 'Remote Extension (Streamable HTTP)' : 'Command-line Extension' }.

{`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◆ What type of extension would you like to add? ${ isHttp ? '│ ○ Built-in Extension\n│ ○ Command-line Extension\n// highlight-start\n│ ● Remote Extension (Streamable HTTP) (Connect to a remote extension via MCP Streamable HTTP)\n// highlight-end' : '│ ○ Built-in Extension\n// highlight-start\n│ ● Command-line Extension (Run a local command or script)\n// highlight-end\n│ ○ Remote Extension (Streamable HTTP)' } └`}

Give your extension a name.

Enter the Streamable HTTP endpoint URI.

{commandNote && ( <> {commandNote}
)} {`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◇ What type of extension would you like to add? │ Remote Extension (Streamable HTTP) │ ◇ What would you like to call this extension? │ ${name} │ // highlight-start ◆ What is the Streamable HTTP endpoint URI? │ ${url} // highlight-end └`} ) : ( <>

Enter the command to run when this extension is used.

{commandNote && ( <> {commandNote}
)} {`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◇ What type of extension would you like to add? │ Command-line Extension │ ◇ What would you like to call this extension? │ ${name} │ // highlight-start ◆ What command should be run? │ ${command} // highlight-end └`} )}

Enter the number of seconds goose should wait for actions to complete before timing out. Default is{' '} 300 seconds.

{`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◇ What type of extension would you like to add? │ ${isHttp ? 'Remote Extension (Streamable HTTP)' : 'Command-line Extension'} │ ◇ What would you like to call this extension? │ ${name} │ ${ isRemote ? `◇ What is the Streamable HTTP endpoint URI?\n│ ${url}\n│` : `◇ What command should be run?\n│ ${command}\n│` } // highlight-start ◆ Please set the timeout for this tool (in secs): │ ${timeout} // highlight-end └`}

Enter a description for this extension.

{`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◇ What type of extension would you like to add? │ ${isHttp ? 'Remote Extension (Streamable HTTP)' : 'Command-line Extension'} │ ◇ What would you like to call this extension? │ ${name} │ ${ isRemote ? `◇ What is the Streamable HTTP endpoint URI?\n│ ${url}\n│` : `◇ What command should be run?\n│ ${command}\n│` } ◇ Please set the timeout for this tool (in secs): │ ${timeout} │ // highlight-start ◆ Enter a description for this extension: │ ${description} // highlight-end └`}

{hasEnvVars ? isHttp ? <>Add {envVars.length > 1 ? 'custom headers' : 'a custom header'} for this extension. : <>Add {envVars.length > 1 ? 'environment variables' : 'an environment variable'} for this extension. : isHttp ? <>Choose No when asked to add custom headers. : <>Choose No when asked to add environment variables. }

{!hasEnvVars && ( {`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◇ What type of extension would you like to add? │ ${isHttp ? 'Remote Extension (Streamable HTTP)' : 'Command-line Extension'} │ ◇ What would you like to call this extension? │ ${name} │ ${ isRemote ? `◇ What is the Streamable HTTP endpoint URI?\n│ ${url}\n│` : `◇ What command should be run?\n│ ${command}\n│` } ◇ Please set the timeout for this tool (in secs): │ ${timeout} │ ◇ Enter a description for this extension: │ ${description} │ // highlight-start ◆ ${lastStepText} │ No // highlight-end │ └ Added ${name} extension`} )} {hasEnvVars && ( <> {infoNote && ( <> {infoNote}
)} {`┌ goose-configure │ ◇ What would you like to configure? │ Add Extension │ ◇ What type of extension would you like to add? │ ${isHttp ? 'Remote Extension (Streamable HTTP)' : 'Command-line Extension'} │ ◇ What would you like to call this extension? │ ${name} │ ${ isRemote ? `◇ What is the Streamable HTTP endpoint URI?\n│ ${url}\n│` : `◇ What command should be run?\n│ ${command}\n│` } ◇ Please set the timeout for this tool (in secs): │ ${timeout} │ ◇ Enter a description for this extension: │ ${description} │ // highlight-start ◆ ${lastStepText} │ Yes ${envVars .map( ({ key, value }, i) => `│ ◇ ${isHttp ? 'Header name' : 'Environment variable name'}: │ ${key} │ ◇ ${isHttp ? 'Header value' : 'Environment variable value'}: │ ${value} │ ◇ Add another ${isHttp ? 'header' : 'environment variable'}? │ ${i === envVars.length - 1 ? 'No' : 'Yes'}` ) .join('\n')} // highlight-end │ └ Added ${name} extension`} )}

); }