Skip to content

Commit e14fc8a

Browse files
Updating /docs-v2 and /mcp readmes (#17566)
* Updating /docs-v2 and /mcp readmes * Update package.json
1 parent f719db6 commit e14fc8a

File tree

4 files changed

+26
-11
lines changed

4 files changed

+26
-11
lines changed

docs-v2/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Pipedream docs
22

3+
> [!WARNING]
4+
> **⚠️ THIS PROJECT IS DEPRECATED ⚠️**
5+
>
6+
> This docs-v2 directory is no longer maintained. Do not make changes to files in this directory as they will not be deployed or used.
7+
>
8+
> The documentation has been moved to a new location. Please contact the team for the current documentation repository.
9+
310
## Quickstart
411

512
[Install `asdf`](https://asdf-vm.com/guide/getting-started.html) if you haven't already.

docs-v2/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Pipedream docs",
55
"private": true,
66
"scripts": {
7+
"predev": "echo '' && echo '⚠️ WARNING: This docs-v2 project is DEPRECATED!' && echo '⚠️ Do not commit changes to this directory.' && echo '⚠️ The documentation has moved to a new location.' && echo ''",
78
"dev": "next dev",
89
"build": "next build",
910
"postbuild": "next-sitemap",

modelcontextprotocol/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
# Pipedream MCP Server
22

3-
This is a reference implementation of the Pipedream MCP server. You can run **your own MCP server** for [over 2,500 apps and APIs](https://pipedream.com/apps) and is powered by [Pipedream Connect](https://pipedream.com/docs/connect/).
3+
This is a reference implementation of the Pipedream MCP server. You can run **your own MCP server** for [over 2,700 apps and APIs](https://pipedream.com/apps) and is powered by [Pipedream Connect](https://pipedream.com/docs/connect/).
44

5-
You can:
5+
> [Note]
6+
> These docs discuss how you can host Pipedream's MCP server in your own app or run it locally. To use Pipedream's [remote MCP server](https://pipedream.com/docs/connect/mcp/developers) (most common), [refer to our docs](https://pipedream.com/docs/connect/mcp/developers) to get started.
7+
8+
This reference implementation shows how you can:
69

710
- [Run the servers locally](#running-the-server-via-npx) with `npx @pipedream/mcp`
811
- [Host the servers yourself](#hosting-your-own-server) to use them within your app or company
912

10-
See the server in action at [mcp.pipedream.com](https://mcp.pipedream.com) and [chat.pipedream.com](https://chat.pipedream.com)
13+
See the consumer-facing MCP server in action at [mcp.pipedream.com](https://mcp.pipedream.com) and check out a demo of the developer-facing product at [chat.pipedream.com](https://chat.pipedream.com).
1114

1215
We published this code as a reference, so you can better understand how to use Pipedream Connect for such
13-
an application. This is still a work in progress, and not fully documented. Please reach out to us if you
16+
an application. This is a reference implementation specifically for self-hosting the server and may not be fully documented. Please reach out to us if you
1417
have any questions.
1518

1619
## ⭐ Features
1720

18-
- Run **your own MCP server** for [over 2,500 apps and APIs](https://pipedream.com/apps)
21+
- Run **your own MCP server** for [over 2,700 apps and APIs](https://mcp.pipedream.com)
1922
- Manage servers **for your users**, in your own app.
2023
- Connect accounts, configure params, and make API requests, all via tools
2124
- Fully-managed OAuth and credential storage ([see security docs](https://pipedream.com/docs/privacy-and-security/#third-party-oauth-grants-api-keys-and-environment-variables))
@@ -59,10 +62,7 @@ All the tools available for that app will be available at that endpoint.
5962
This is an experimental version, since it relies on tools being able to update dynamically.
6063
We use this server to power the tools on [chat.pipedream.com](https://chat.pipedream.com).
6164

62-
> [!NOTE]
63-
> The code for the dynamic MCP server is available in this repo but you will not _yet_ be able to run it locally since it relies on an internal db.
64-
>
65-
> Please let us know if you'd like to run this yourself.
65+
> [!NOTE] > [Check out the docs](https://pipedream.com/docs/connect/mcp/app-discovery) to learn more about enabling app discovery with the MCP server.
6666
6767
## Hosting your own server
6868

pnpm-lock.yaml

Lines changed: 9 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)