From 17d7082f7c1bbe1877daf4d34018db5cac8e539d Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Wed, 16 Apr 2025 12:43:14 -0700 Subject: [PATCH] small rev to docs --- docs-v2/pages/connect/components.mdx | 24 ++++++++++++------------ docs-v2/pages/connect/mcp.mdx | 10 ++++++++-- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/docs-v2/pages/connect/components.mdx b/docs-v2/pages/connect/components.mdx index f4257be884b9d..1d9c4433be5fa 100644 --- a/docs-v2/pages/connect/components.mdx +++ b/docs-v2/pages/connect/components.mdx @@ -144,7 +144,7 @@ const components = await pd.getComponents({ q: "gitlab" }); ```bash curl -X https://api.pipedream.com/v1/connect/{project_id}/actions?app=gitlab \ -H "Content-Type: application/json" \ - -H "X-PD-Environment: development" \ + -H "X-PD-Environment: {environment}" \ -H "Authorization: Bearer {access_token}" # Parse and return the data you need @@ -239,7 +239,7 @@ const component = await pd.getComponent({ key: "gitlab-list-commits" }); ```bash curl -X https://api.pipedream.com/v1/connect/{project_id}/components/gitlab-list-commits \ -H "Content-Type: application/json" \ - -H "X-PD-Environment: development" \ + -H "X-PD-Environment: {environment}" \ -H "Authorization: Bearer {access_token}" # Parse and return the data you need @@ -346,7 +346,7 @@ const { options } = await pd.configureComponent({ ```bash curl -X POST https://api.pipedream.com/v1/connect/{project_id}/components/configure \ -H "Content-Type: application/json" \ - -H "X-PD-Environment: development" \ + -H "X-PD-Environment: {environment}" \ -H "Authorization: Bearer {access_token}" \ -d '{ "external_user_id": "abc-123", @@ -450,7 +450,7 @@ For example, to retrieve the configuration options for the `refName` prop: } ``` -### Configure dynamic props (optional) +### Configure dynamic props The set of props that a component can accept might not be static, and may change depending on the values of prior props. Props that behave this way are called @@ -617,16 +617,16 @@ const resp = await pd.runAction({ ```bash curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \ -H "Content-Type: application/json" \ - -H "X-PD-Environment: development" \ + -H "X-PD-Environment: {environment}" \ -H "Authorization: Bearer {access_token}" \ -d '{ "external_user_id": "abc-123", "id": "gitlab-list-commits", - "prop_name": "projectId", "configured_props": { "gitlab": { "authProvisionId": "apn_kVh9AoD" - } + }, + "projectId": 45672541, } }' @@ -709,11 +709,11 @@ Deploy a source for your users: const { data: deployedTrigger } = await pd.deployTrigger({ externalUserId: "abc-123", id: "gitlab-new-issue", - propName: "projectId", configuredProps: { gitlab: { authProvisionId: "apn_kVh9AoD", - } + }, + projectId: 45672541, }, webhookUrl: "https://events.example.com/gitlab-new-issue" }); @@ -731,16 +731,16 @@ const { ```bash curl -X POST https://api.pipedream.com/v1/connect/{project_id}/components/triggers/deploy \ -H "Content-Type: application/json" \ - -H "X-PD-Environment: development" \ + -H "X-PD-Environment: {environment}" \ -H "Authorization: Bearer {access_token}" \ -d '{ "external_user_id": "abc-123", "id": "gitlab-new-issue", - "prop_name": "projectId", "configured_props": { "gitlab": { "authProvisionId": "apn_kVh9AoD" - } + }, + "projectId": 45672541, }, "webhook_url": "https://events.example.com/gitlab-new-issue" }' diff --git a/docs-v2/pages/connect/mcp.mdx b/docs-v2/pages/connect/mcp.mdx index 4f873637e4b84..90616481cedbd 100644 --- a/docs-v2/pages/connect/mcp.mdx +++ b/docs-v2/pages/connect/mcp.mdx @@ -16,7 +16,7 @@ Pipedream's MCP servers are powered by [Pipedream Connect](https://pipedream.com - Secure account connections with revocable access -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. +User credentials are encrypted at rest and all requests are made through Pipedream's servers, never directly exposing credentials to AI models. Read more about how we protect user credentials [here](/privacy-and-security/#third-party-oauth-grants-api-keys-and-environment-variables). ## Available MCP servers @@ -170,13 +170,19 @@ Pipedream's MCP servers enable AI assistants to perform a wide range of tasks: - Each MCP server provides tools specific to that app. Tools are automatically created based on Pipedream's registry of pre-built actions. - 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). +## Known gaps and limitations + +- Pipedream's MCP server doesn't yet support [configuring dynamic props](/connect/components/#configure-dynamic-props), which means LLMs may get confused when trying to configure props that require inputs from previous props +- As an end user, you need to manually add distinct MCP servers for every app you want to interact with, instead of using a single MCP server that contains tools for many APIs + ## Pricing - Anyone can use Pipedream's hosted MCP servers for their own use **for free** - To deploy Pipedream's MCP servers to your own app or agent, [contact our sales team](https://pipedream.com/pricing?plan=Enterprise) -## Resources +## Additional resources +- [Pipedream hosted MCP servers](https://mcp.pipedream.com) - [MCP official spec](https://modelcontextprotocol.io/) - [Pipedream MCP reference implementation](https://github.com/PipedreamHQ/pipedream/tree/master/modelcontextprotocol) - [MCP inspector tool](https://modelcontextprotocol.io/docs/tools/inspector/) \ No newline at end of file