Create Connector

Follow only the steps for the chosen path. Do not mix them.

Step 2: Create the Connector Spec

Create the connector spec in src/platform/packages/shared/kbn-connector-specs/src/specs/{connector_name}/.

Follow the patterns in reference/connector-patterns.md:

1. {connector_name}.ts — ConnectorSpec definition with metadata, auth, schema, and actions
2. types.ts — Zod input schemas and inferred TypeScript types for each action
3. {connector_name}.test.ts — Unit tests
4. icon/index.tsx — Brand icon component

Register in src/platform/packages/shared/kbn-connector-specs/src/all_specs.ts and connector_icons_map.ts.

Replace the placeholder icon with a proper brand icon. Search for existing SVG/PNG files in:

• src/platform/packages/shared/kbn-connector-specs/src/specs/*/icon/
• x-pack/platform/plugins/shared/stack_connectors/public/connector_types/{connector}/

Step 3: Write LLM-Quality Descriptions and Skill Content

AI agents rely on descriptions to choose the right action and construct valid inputs. Every action and parameter must have high-quality descriptive text.

isTool and action descriptions

Actions should set isTool: true to be discoverable by AI agents in Agent Builder. This is the default for most actions. Use isTool: false only for actions that should not be invoked autonomously (e.g. destructive or admin-only operations).

Every entry MUST have a description field (plain string, NOT i18n.translate()) that explains:

• What the action does
• When an agent should use it (vs. other actions)
• What it returns
• For download/binary actions: a WARNING about large base64 payloads and the need for post-processing

Parameter descriptions

Every Zod parameter in input schemas MUST have a .describe() call that includes:

• What the parameter controls
• Concrete examples or allowed values
• Any constraints (format, length, required vs. optional behavior)

See the ServiceNow, Slack, and GitHub connector specs for examples of strong description quality.

The skill property

Add a skill property to the ConnectorSpec — a markdown string providing higher-level LLM guidance:

• Multi-step workflow patterns (e.g., "to create an incident, first call X, then Y")
• Common gotchas and error cases
• Best practices for the service

Use the [...].join('\n') pattern to keep the string readable in source: