feat: add description field to connector configuration entries

integ-tests/add-remove-web-search.test.ts

@@ -9,6 +9,7 @@ const telemetry = createTelemetryHelper();
 
 interface ConfigurationEntry {
   name: string;
+  description?: string;
   parameterValues?: Record<string, unknown>;
   parameterOverrides?: { path: string; description?: string; visible?: boolean }[];
 }
@@ -84,6 +85,7 @@ describe('integration: add and remove web-search via --connector flag', () => {
     expect(target?.connectorId).toBe('web-search');
     expect(target?.configurations).toHaveLength(1);
     expect(target?.configurations?.[0]?.name).toBe('WebSearch');
+    expect(target?.configurations?.[0]?.description).toBe('');
     expect(target?.configurations?.[0]?.parameterValues).toEqual({});
     expect(target?.configurations?.[0]?.parameterOverrides).toEqual([]);
     telemetry.assertMetricEmitted({ command: 'add.gateway-target', exit_reason: 'success' });

src/cli/operations/connectors/translators.ts

@@ -8,6 +8,7 @@
 
 export interface ConfigurationEntry {
   name: string;
+  description: string;
   parameterValues: Record<string, unknown>;
   parameterOverrides: ParameterOverride[];
 }
@@ -35,13 +36,15 @@ function translateWebSearch(input: WebSearchTranslatorInput): ConfigurationEntry
   if (input.excludeDomains && input.excludeDomains.length > 0) {
     parameterValues.domainFilter = { exclude: input.excludeDomains };
   }
-  return [{ name: 'WebSearch', parameterValues, parameterOverrides: [] }];
+  return [{ name: 'WebSearch', description: '', parameterValues, parameterOverrides: [] }];
 }
 
 function translateKnowledgeBases(input: KnowledgeBasesTranslatorInput): ConfigurationEntry[] {
   return [
     {
       name: 'AgenticRetrieveStream',
+      description:
+        'Streaming endpoint for agentic retrieval from knowledge bases. Performs multi-step retrieval with planning and returns results as a stream of events.',
       parameterValues: {
         retrievers: [{ configuration: { knowledgeBase: { knowledgeBaseId: input.knowledgeBaseId } } }],
         agenticRetrieveConfiguration: { foundationModelType: 'MANAGED', rerankingModelType: 'MANAGED' },
@@ -50,6 +53,7 @@ function translateKnowledgeBases(input: KnowledgeBasesTranslatorInput): Configur
     },
     {
       name: 'Retrieve',
+      description: 'Queries a knowledge base and retrieves information from it.',
       parameterValues: { knowledgeBaseId: input.knowledgeBaseId },
       parameterOverrides: [],
     },

src/schema/schemas/mcp.ts

@@ -474,6 +474,7 @@ export const AgentCoreGatewayTargetSchema = z
       .array(
         z.object({
           name: z.string(),
+          description: z.string().optional(),
           parameterValues: z.record(z.string(), z.unknown()).optional(),
           parameterOverrides: z
             .array(