Skip to content

Updating /docs-v2 and /mcp readmes #17566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 10, 2025
Merged

Updating /docs-v2 and /mcp readmes #17566

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa46637
Updating /docs-v2 and /mcp readmes
dannyroosevelt Jul 10, 2025
758e4c4
Update package.json
dannyroosevelt Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs-v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Pipedream docs

> [!WARNING]
> **⚠️ THIS PROJECT IS DEPRECATED ⚠️**
>
> 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.
>
> The documentation has been moved to a new location. Please contact the team for the current documentation repository.

## Quickstart

[Install `asdf`](https://asdf-vm.com/guide/getting-started.html) if you haven't already.
Expand Down
1 change: 1 addition & 0 deletions docs-v2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Pipedream docs",
"private": true,
"scripts": {
"predev": "echo '\\n⚠️ WARNING: This docs-v2 project is DEPRECATED!\\n⚠️ Do not commit changes to this directory.\\n⚠️ The documentation has moved to a new location.\\n' && sleep 3",
Copy link
Contributor

@coderabbitai coderabbitai bot Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

echo escape sequences won’t render newlines on many shells
Without -e, the \n literals are printed verbatim, and Windows’ cmd lacks sleep.

-    "predev": "echo '\\n⚠️  WARNING: This docs-v2 project is DEPRECATED!\\n⚠️  Do not commit changes to this directory.\\n⚠️  The documentation has moved to a new location.\\n' && sleep 3",
+    "predev": "printf '\\n⚠️  WARNING: This docs-v2 project is DEPRECATED!\\n⚠️  Do not commit changes to this directory.\\n⚠️  The documentation has moved to a new location.\\n\\n' ; node -e \"setTimeout(()=>{},3000)\"",

This keeps the warning cross-platform and avoids relying on *nix-only utilities.

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In docs-v2/package.json at line 7, the predev script uses echo with \n escape
sequences which do not render newlines on many shells and uses sleep which is
not available on Windows cmd. Replace the echo command with multiple echo
statements or a cross-platform method to print newlines properly, and remove or
replace sleep with a cross-platform alternative to ensure the warning message
displays correctly on all platforms.

"dev": "next dev",
"build": "next build",
"postbuild": "next-sitemap",
Expand Down
18 changes: 9 additions & 9 deletions modelcontextprotocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# Pipedream MCP Server

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/).
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/).

You can:
> [Note]
> 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.

This reference implementation shows how you can:

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

See the server in action at [mcp.pipedream.com](https://mcp.pipedream.com) and [chat.pipedream.com](https://chat.pipedream.com)
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).

We published this code as a reference, so you can better understand how to use Pipedream Connect for such
an application. This is still a work in progress, and not fully documented. Please reach out to us if you
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
have any questions.

## ⭐ Features

- Run **your own MCP server** for [over 2,500 apps and APIs](https://pipedream.com/apps)
- Run **your own MCP server** for [over 2,700 apps and APIs](https://mcp.pipedream.com)
- Manage servers **for your users**, in your own app.
- Connect accounts, configure params, and make API requests, all via tools
- 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))
Expand Down Expand Up @@ -59,10 +62,7 @@ All the tools available for that app will be available at that endpoint.
This is an experimental version, since it relies on tools being able to update dynamically.
We use this server to power the tools on [chat.pipedream.com](https://chat.pipedream.com).

> [!NOTE]
> 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.
>
> Please let us know if you'd like to run this yourself.
> [!NOTE] > [Check out the docs](https://pipedream.com/docs/connect/mcp/app-discovery) to learn more about enabling app discovery with the MCP server.

## Hosting your own server

Expand Down
11 changes: 9 additions & 2 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading