Skip to main content

​
Before You Begin

Make sure you have:
  • Access to Bud Admin.
  • Permission to manage connectors for the target project or organization.
  • Provider credentials, API keys, headers, or OAuth client setup required by the connector.
  • An agent that should use the connector tools.

​
Step 1: Find the Connector

  1. Open Connectors.
  2. Search for the provider or tool server.
  3. Select the connector card.
  4. Review its authentication type and credential fields.

​
Step 2: Configure Credentials

Credential fields come from the connector schema. Bud Admin supports standard text, password, URL, dropdown, hidden, and key-value-array field types. Enter the required values and verify optional fields such as base URL, headers, or custom names.

​
Step 3: Choose Agent Visibility

Set the connection scope before saving:
  • Use Global for shared enterprise systems.
  • Use Project for restricted project data.
  • Keep narrow scopes during testing, then widen later from the connection settings.

​
Step 4: Save the Gateway

Click Save or Connect. Bud Admin sends the connector ID, credentials, optional name, and scope to the connector gateway API. A successful save creates a reusable gateway and moves the connection to the Connections tab.

​
Step 5: Complete OAuth If Required

For OAuth connectors:
  1. Open the connection from the agent builder.
  2. Click Connect.
  3. Finish provider authorization.
  4. Return to the original Bud Admin page.
  5. Confirm the connection shows an authorized state.

​
Step 6: Fetch and Attach Tools

  1. Expand the connection in the agent builder.
  2. Load or refresh the tool list.
  3. Select only the tools the agent needs.
  4. Click Add to agent.
The selected tool IDs replace that agent’s existing selection for the same gateway.

​
Step 7: Validate the Agent

Run a test conversation that should call the connected tool. Confirm that:
  • The agent can see the selected tool.
  • The tool call succeeds.
  • The response uses the intended external data or action.
  • The tool set remains scoped to the intended project.

​
Success Checklist

  • The connector appears under configured Connections.
  • OAuth status is connected when required.
  • Tools load from the gateway.
  • The correct tool IDs are attached to the agent.
  • Project or global visibility matches your governance requirement.