Skip to content

Commit f81d9a8

Browse files
committed
Add docs for the connectors feature
1 parent f06e3eb commit f81d9a8

6 files changed

Lines changed: 66 additions & 0 deletions

File tree

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
"group": "Ask Sourcebot",
6666
"root": "docs/features/ask/ask-sourcebot",
6767
"pages": [
68+
"docs/features/ask/connectors",
6869
"docs/features/ask/chat-sharing",
6970
"docs/features/ask/add-model-providers"
7071
]
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Connectors
3+
---
4+
5+
Connectors let Ask Sourcebot access your apps and services so it can answer questions and take action on your behalf.
6+
7+
They communicate over MCP and use the same permission boundaries as the connected user. This means a connector can only retrieve data that the user is authorized to access.
8+
9+
Once [configured](#configuration), connectors make Ask Sourcebot more useful across your workflow. For example, Ask Sourcebot can help identify the root cause of a bug in your codebase, then create a Linear or Jira
10+
issue with the findings and a link to the chat so teammates can pick up where you left off.
11+
12+
## Usage
13+
14+
From the Ask page, you can choose which connectors are available for each chat.
15+
16+
Turn off a connector to prevent Ask Sourcebot from using it in that chat.
17+
18+
<Frame>
19+
<img src="/images/connectors_toggle_off.png" alt="Toggle off connector" />
20+
</Frame>
21+
22+
During a chat, Ask Sourcebot shows each connector tool it uses.
23+
24+
If Ask Sourcebot needs to use a tool that requires approval, it pauses and asks for your permission before continuing.
25+
26+
<Frame>
27+
<img src="/images/connectors_permission_request.png" alt="Request tool permission" />
28+
</Frame>
29+
30+
## Configuration
31+
32+
An owner must add a connector before organization members can use it.
33+
34+
To add a connector:
35+
1. **Settings → Workspace → Ask Agent**
36+
2. Click **Add connector**.
37+
3. Enter the MCP server URL and the name the organization will see for this server.
38+
39+
Most MCP servers support dynamic client registration. When this is available, Sourcebot registers with the server automatically.
40+
41+
Some MCP servers require a pre-registered OAuth app instead. In that case, an owner must register Sourcebot with the connector platform first,
42+
then enter the OAuth client ID and client secret in Sourcebot.
43+
44+
<div className="max-w-sm mx-auto">
45+
<Frame>
46+
<img
47+
src="/images/connectors_static_registration.png"
48+
alt="OAuth client credentials dialog for a Slack connector"
49+
/>
50+
</Frame>
51+
</div>
52+
53+
## Connecting
54+
55+
After an owner adds connectors for your organization, go to **Settings → Account → Ask Agent** to connect them.
56+
57+
You can see all available connectors on this page. After you connect one, you can inspect the tools it provides and what each tool does.
58+
59+
<div className="max-w-xl mx-auto">
60+
<Frame>
61+
<img src="/images/connectors_account_page.png" alt="Account connectors page" />
62+
</Frame>
63+
</div>
64+
65+
141 KB
Loading
181 KB
Loading
97.4 KB
Loading
163 KB
Loading

0 commit comments

Comments
 (0)