View as Markdown
Clearly Defined icon

Clearly Defined ACTION

Get Harvests

Get all the harvested data for a component revision. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Clearly Defined account once, then configure and run Get Harvests from your backend or agent.

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: "clearly_defined-get-harvests",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clearly_defined: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    provider: "Provider",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Harvests inputs
Property Type Description
type Type string
The type of component
Required
provider Provider string
Where the component can be found
Required
namespace Namespace string
Many component systems have namespaces. GitHub orgs, NPM namespace, Maven group id, Conda Subdir/Architecture. If your component does not have a namespace, use '-' (ASCII hyphen).
Required
name Name string
The name of the component you want
Required
revision Revision string
Components typically have some differentiator like a version or commit id. Use that here. If this segment is omitted, the latest revision is used (if that makes sense for the provider).
Optional
form Form string
Form of the response
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
clearly_defined-get-harvests
Version
0.0.2
App
Clearly Defined
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes