CONNECT APP
Build with CircleCI
Developer Tools
- API key
MCP
Give your agent CircleCI tools
Every CircleCI action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's CircleCI account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "circleci",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Get Job Artifacts:
const result = await mcp.callTool({
name: "circleci-get-job-artifacts",
arguments: {
projectSlug: "Project Slug",
pipelineId: "Pipeline ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "circleci",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Get Job Artifacts:
result = await session.call_tool("circleci-get-job-artifacts", {
"projectSlug": "Project Slug",
"pipelineId": "Pipeline ID",
})API PROXY
Call the CircleCI API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the CircleCI API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://circleci.com/api/v1.1/me",
})
// Any allowed CircleCI endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://circleci.com/api/v1.1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9jaXJjbGVjaS5jb20vYXBpL3YxLjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run CircleCI actions from your backend
Connect a user's CircleCI account once, then run Get Job Artifacts on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "circleci-get-job-artifacts",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
circleci: { authProvisionId: "apn_xxxxxxx" },
projectSlug: "Project Slug",
pipelineId: "Pipeline ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="circleci-get-job-artifacts",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"circleci": {"authProvisionId": "apn_xxxxxxx"},
"projectSlug": "Project Slug",
"pipelineId": "Pipeline ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "circleci-get-job-artifacts",
"configured_props": {
"circleci": { "authProvisionId": "apn_xxxxxxx" },
"projectSlug": "Project Slug",
"pipelineId": "Pipeline ID"
}
}'TOOLS
CircleCI actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Get Job Artifacts
actionRetrieves a job's artifacts. See the documentation.Read-onlyv0.0.2 -
Rerun Workflow
actionReruns the specified workflow. See the documentationWritev0.0.2 -
Trigger a Pipeline
actionTrigger a pipeline given a pipeline definition ID. Supports all integrations except GitLab. See the documentationWritev0.0.3
EVENTS
CircleCI triggers
Event sources your backend can deploy for users and receive through a webhook.
MULTI-APP
Use CircleCI with other popular apps
Most products don't stop at one integration. Pair CircleCI with the other apps your users rely on, and ship use cases that span both.
- App slug
- circleci
- Authentication
- API key
- Categories
- Developer Tools
- Actions
- 3
- Triggers
- 2
- API proxy
- Available