Skip to content

Commit da6dc5b

Browse files
MCP docs (#16314)
* MCP docs * Update mcp.mdx
1 parent f638ae8 commit da6dc5b

File tree

2 files changed

+185
-0
lines changed

2 files changed

+185
-0
lines changed

docs-v2/pages/connect/_meta.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ export default {
1111
"components": {
1212
"title": "Pre-built tools",
1313
},
14+
"mcp": {
15+
"title": "MCP servers",
16+
},
1417
"api-proxy": {
1518
"title": "API proxy",
1619
},

docs-v2/pages/connect/mcp.mdx

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
import Callout from '@/components/Callout'
2+
import { Steps, Tabs } from 'nextra/components'
3+
import Image from 'next/image'
4+
5+
# MCP Servers
6+
7+
Pipedream offers dedicated MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) servers for all of our {process.env.PUBLIC_APPS}+ integrated apps. These servers enable AI assistants like Claude to securely access and interact with thousands of APIs through a standardized communication protocol, performing real-world tasks by connecting to your accounts.
8+
9+
![MCP visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1714074324/pd-mcp-illustration_y76lnt.webp)
10+
11+
Pipedream's MCP servers are powered by [Pipedream Connect](https://pipedream.com/docs/connect), including:
12+
13+
- Access to {process.env.PUBLIC_APPS}+ apps and APIs through a consistent interface
14+
- Over 10,000 pre-built tools and actions
15+
- Fully-managed OAuth and credential storage
16+
- Secure account connections with revocable access
17+
18+
<Callout type="info">
19+
Pipedream handles all OAuth and credential management through our [secure credential infrastructure](/privacy-and-security/#third-party-oauth-grants-api-keys-and-environment-variables). User credentials are encrypted at rest and all requests are made through Pipedream's servers, never directly exposing credentials to AI models.
20+
</Callout>
21+
22+
## Available MCP servers
23+
24+
Pipedream provides MCP servers for all our [supported apps](https://pipedream.com/apps). Each app has its own dedicated MCP server with tools specific to that API. For example:
25+
26+
- **[Slack MCP server](https://mcp.pipedream.com/app/slack)**: Send messages, manage channels, create reminders, and more
27+
- **[GitHub MCP server](https://mcp.pipedream.com/app/github)**: Create issues, manage pull requests, search repositories
28+
- **[Google Sheets MCP server](https://mcp.pipedream.com/app/google-sheets)**: Read and write data, format cells, create charts
29+
30+
Explore the full list of available MCP servers at [mcp.pipedream.com](https://mcp.pipedream.com).
31+
32+
## Getting started
33+
34+
You can use Pipedream's MCP servers in two ways:
35+
36+
1. **[As an end user](#for-end-users)**: Connect your accounts through our hosted MCP servers at [mcp.pipedream.com](https://mcp.pipedream.com)
37+
2. **[As a developer](#for-developers)**: Host your own MCP servers for your application or organization
38+
39+
### For end users
40+
41+
Set up MCP servers to use with any compatible MCP client, like Claude Desktop, Windsurf, Cursor, and VS Code.
42+
43+
<Steps>
44+
45+
#### Configure MCP servers and connect accounts
46+
47+
- Navigate to [mcp.pipedream.com](https://mcp.pipedream.com) and sign in or create an account (this is a separate account from pipdream.com)
48+
- Browse available MCP servers
49+
- Follow the configuration instructions on the server page to add it to your preferred MCP client
50+
- Connect your account (you can do this in the UI or the AI will prompt you when you first use a tool)
51+
52+
#### Start chatting
53+
54+
Ask the LLM or agent to perform tasks using your connected services. For example:
55+
56+
- "Send a message to my team in Slack"
57+
- "Create a new issue in GitHub"
58+
- "Add data to my Google Sheet"
59+
60+
The AI will refer to the configured tools available in its MCP servers to complete the task.
61+
62+
#### Get things done
63+
64+
With MCP-enabled AI, you can:
65+
66+
- Send messages and manage communication
67+
- Create and update documents
68+
- Query and analyze data
69+
- Automate workflows across your favorite tools
70+
71+
All using your own connected accounts with full control and security.
72+
73+
</Steps>
74+
75+
### For developers
76+
77+
Deploy Pipedream's MCP servers to your application or agent and make authenticated request on behalf of your customers. Refer to our reference implementation [here](https://github.com/PipedreamHQ/pipedream/blob/master/modelcontextprotocol/README.md).
78+
79+
<Steps>
80+
81+
#### Prerequisites
82+
83+
To run your own MCP server, you'll need:
84+
85+
1. A [Pipedream account](https://pipedream.com/auth/signup)
86+
2. A [Pipedream project](/workflows/projects/#creating-projects). Accounts connected via MCP will be stored here.
87+
3. [Pipedream OAuth credentials](/connect/managed-auth/oauth-clients/)
88+
89+
#### Set up environment variables
90+
91+
Set the following environment variables:
92+
93+
```bash
94+
PIPEDREAM_CLIENT_ID=your_client_id
95+
PIPEDREAM_CLIENT_SECRET=your_client_secret
96+
PIPEDREAM_PROJECT_ID=your_project_id
97+
PIPEDREAM_PROJECT_ENVIRONMENT=development
98+
```
99+
100+
#### Run the MCP server
101+
102+
Pipedream's MCP servers can run in two modes:
103+
104+
##### Stdio (for local testing)
105+
106+
```bash
107+
npx @pipedream/mcp stdio --app slack --external-user-id user123
108+
```
109+
110+
##### SSE (for hosting)
111+
112+
```bash
113+
npx @pipedream/mcp sse
114+
```
115+
116+
This exposes routes at:
117+
- `GET /:external_user_id/:app` - App-specific SSE connection endpoint
118+
- `POST /:external_user_id/:app/messages` - App-specific message handler
119+
120+
Where:
121+
- `:external_user_id` is your user's unique identifier in your system
122+
- `:app` is the app slug (e.g., "slack", "github")
123+
124+
#### Customize for your needs
125+
126+
You can host and customize the MCP server for your specific requirements:
127+
128+
```bash
129+
# Clone the repo
130+
git clone https://github.com/PipedreamHQ/pipedream
131+
cd pipedream/modelcontextprotocol
132+
133+
# Install dependencies
134+
npm install
135+
136+
# Build
137+
npm run build
138+
139+
# Run the SSE server
140+
npm run start:sse:prod
141+
```
142+
143+
See the [MCP server README](https://github.com/PipedreamHQ/pipedream/blob/master/modelcontextprotocol/README.md) for detailed instructions on customization options.
144+
145+
</Steps>
146+
147+
## Security
148+
149+
MCP servers follow strict security best practices:
150+
151+
- **Credential isolation**: Each user's credentials are stored securely and isolated from other users
152+
- **No credential exposure**: Credentials are never exposed to AI models or your client-side code
153+
- **Request authentication**: All requests to the MCP server are authenticated
154+
- **Revocable access**: Users can revoke access to their connected accounts at any time
155+
156+
For more information on security, see our [security documentation](/privacy-and-security/).
157+
158+
## Use cases
159+
160+
Pipedream's MCP servers enable AI assistants to perform a wide range of tasks:
161+
162+
- **Productivity automation**: Schedule meetings, send emails, create documents
163+
- **Data analysis**: Query databases, analyze spreadsheets, generate reports
164+
- **Content creation**: Post social media updates, create marketing materials
165+
- **Customer support**: Respond to inquiries, create tickets, update CRM records
166+
- **Developer workflows**: Create issues, review code, deploy applications
167+
168+
## Supported tools
169+
170+
- Each MCP server provides tools specific to that app. Tools are automatically created based on Pipedream's registry of pre-built actions.
171+
- You can find the supported tools for a given app on its MCP server page or search for specific actions here: [pipedream.com/expore](https://pipedream.com/explore#popular-actions).
172+
173+
## Pricing
174+
175+
- Anyone can use Pipedream's hosted MCP servers for their own use **for free**
176+
- To deploy Pipedream's MCP servers to your own app or agent, [contact our sales team](https://pipedream.com/pricing?plan=Enterprise)
177+
178+
## Resources
179+
180+
- [MCP official spec](https://modelcontextprotocol.io/)
181+
- [Pipedream MCP reference implementation](https://github.com/PipedreamHQ/pipedream/tree/master/modelcontextprotocol)
182+
- [MCP inspector tool](https://modelcontextprotocol.io/docs/tools/inspector/)

0 commit comments

Comments
 (0)