Before you start
Before you start, sign in to the dashboard and select the organization you want to work in.- You need a role that can manage resources. See Roles and permissions.
- For an API-key connection, have the provider credentials ready.
- Allow pop-up windows for the dashboard. OAuth authorization opens in a new browser tab.
Connect from the Directory
1
Open Tools in the sidebar and select the Directory tab
Use the category buttons, or search for the provider name.
2
Open the toolkit’s More actions menu and select Add tool
Or select View actions in the menu first, then Add Tool in the dialog footer.
3
Enter a Connection Name
The name is optional for OAuth toolkits.
4
Pick a Toolkit version
Keep the default latest version unless you need an older action set.
5
Fill the required fields and select Connect
For OAuth, the provider page opens in a new tab. Sign in and approve access there.
For an API key, a toast confirms the connection or asks you to fill all required fields.
The Add Tool modal
The modal opens with the toolkit logo, name, description, and a Featured badge when it applies. Its fields, top to bottom:
Some credential fields link to a provider help page, labeled How to find this? or How to get this?.
The modal picks the authentication path for you. Toolkits that support OAuth connect with OAuth. Toolkits that only support an API key show the credential fields. To connect a toolkit that supports both with an API key, use the OAuth and API Key switch in the Add another account dialog.
The authorization tab
An OAuth connection opens a new tab with the provider sign-in page. Some paths first show “Redirecting to authorization…”. After you approve access, the tab returns to Tars and reports the outcome:
If the tab does not close, a link offers to head back to the Tools page. The dashboard tab that started the connection updates on its own.
Finish a pending authorization
Until you approve access, the Authorization card on the toolkit detail page reads Waiting for authentication with an Initiated badge. It shows a countdown and a Complete authentication button that reopens the provider page. When the countdown ends, the card reads Authentication expired with an Expired badge.Add another account
The toolkit detail page connects more accounts of the same toolkit. Select Add in the header. The Add dialog opens with the subtitle “Connect another account.” When the toolkit supports both methods, OAuth and API Key buttons switch between the two forms. Each form has the same fields as the Add Tool modal and ends with Connect. The new connection appears in the account picker of the detail page.Rotate API-key credentials
An API-key connection carries a Credentials card on the toolkit detail page. It lists every credential field with its value masked, and each field has an eye button that shows or hides the value. A Last updated date sits under the fields.1
Open Tools, then select More actions and Open on the connection
Pick the right account in the account picker first.
2
Select Edit on the Credentials card
The fields become editable. Edit is shown only to members who can manage resources.
3
Enter the new values and select Update
Tars reconnects with the new credentials.
A Credentials updated message confirms, and the card leaves edit mode.
Change the connected account
An active connection has a Change account button on its Authorization card. The button is shown only to members who can manage resources.1
Open Tools, then select More actions and Open on the connection
Pick the right account in the account picker first.
2
Select Change account on the Authorization card
The dialog states how many gambits and agents use the connection. The change applies to all of them.
3
For an API key, enter a new value for each credential field
Skip this step for an OAuth connection.
4
Select Change account in the dialog
An API-key connection confirms with Account changed. An OAuth connection first refreshes the existing authorization.
A Connection refreshed message confirms. If the provider needs a new approval, a new tab opens instead.
Connection health
The badge on the Connected tab card tells you whether agents can call the toolkit. Only a Connected connection runs actions, and the action toggles on the toolkit detail page are disabled in every other state.
The Authorization card on the toolkit detail page shows the matching state with its repair button.
When a provider revokes access
Providers can remove access outside Tars, for example after a password change or a provider-side policy change. When you open the toolkit detail page, Tars checks the provider and updates the badge to Revoked or Expired. Agents cannot call the toolkit’s actions until you reconnect.1
Open Tools, then select More actions and Open on the affected connection
The Authorization card states the connection state.
2
Select Reconnect or Restore access
Reconnect first refreshes the existing authorization. If the provider rejects the refresh, a new authorization tab opens.
When a toolkit is retired
Tars can retire a toolkit from the directory. A retired toolkit leaves the Directory tab, so you cannot connect it again. A connection you made before the toolkit was retired stays on the Connected tab and keeps working. The Authorization card on its detail page reads ” is no longer available for new connections. This connection keeps working, and you can still manage its actions or delete it.”Verify
Open the Connected tab. The toolkit card shows a Connected badge and its enabled action count. Its detail page says Connection active.The Tools page
Tools in the sidebar opens your connected toolkits and the toolkit directory.The Directory tab
The All, Connected, and Featured category buttons sit beside the tabs. Categories with no toolkits are hidden. Sort orders by Featured, Name, or Recently added. Featured is the default. Recently added orders toolkits by when they joined the directory. The two Connected counts differ. The category counts directory toolkits with at least one connection. The tab counts every connection and every CodeKit toolkit. Per page and the page arrows sit beside Sort. Each card shows the toolkit logo, name, and description. The footer shows whether the toolkit is connected and its action count. A Featured badge marks highlighted toolkits. The More actions menu offers:The Connected tab
When nothing is connected yet, the tab shows “No tools connected yet” and points you to the Directory tab. Each connection card shows:
Filter narrows connected toolkits by Type or Status:
Sort orders connected toolkits by Added or Name. The page controls below the grid move through results and set Rows per page.