View as Markdown
Clearly Defined icon

Clearly Defined ACTION

Get Definitions

Gets the coordinates for all definitions that match the given pattern in the specified part of the definition. 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 Definitions 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-definitions",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clearly_defined: { authProvisionId: "apn_xxxxxxx" },
    pattern: "Pattern",
    type: "Type",
  },
})

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 Definitions inputs
Property Type Description
pattern Pattern string
The string to search for in definition coordinates to get coordinate suggestions
Optional
type Type string
The type of component
Optional
provider Provider string
Where the component can be found
Optional
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).
Optional
name Name string
The name of the component you want
Optional
license License string
The SPDX license identifier
Optional
releasedAfter Released After string
The minimum release date for the component. E.g. 2025-01-01
Optional
releasedBefore Released Before string
The maximum release date for the component. E.g. 2025-01-01
Optional
minLicensedScore Min Licensed Score integer
The minimum effective licensed score for the component
Optional
maxLicensedScore Max Licensed Score integer
The maximum effective licensed score for the component
Optional
minDescribedScore Min Described Score integer
The minimum effective described score for the component
Optional
maxDescribedScore Max Described Score integer
The maximum effective described score for the component
Optional
sort Sort string
The field to sort the results by
Optional
sortDirection Sort Direction string
The direction to sort the results by
Optional
continuationToken Continuation Token string
Used for pagination. Seeded from the results of the previous query
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-definitions
Version
0.0.2
App
Clearly Defined
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes