Npm

Learn how to use Npm with Composio

Overview

SLUG: NPM

Description

npm is the default package manager for JavaScript and Node.js, facilitating the sharing and reuse of code, managing dependencies, and streamlining project workflows.

Authentication Details

generic_api_key
stringRequired

Connecting to Npm

Create an auth config

Use the dashboard to create an auth config for the Npm toolkit. This allows you to connect multiple Npm accounts to Composio for agents to use.

1

Select App

Navigate to Npm.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Npm Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4npm_auth_config_id = "ac_YOUR_NPM_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Npm for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, npm_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Npm toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["NPM"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get NPM Download Counts Point

Description

Tool to get npm package download counts over a period. use after confirming package name and time period.

Action Parameters

package
stringRequired
period
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Download Counts Range

Description

Tool to get daily download counts for an npm package over a date range. use after confirming package name and dates.

Action Parameters

end
stringRequired
package
stringRequired
start
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Package Download Counts Over Date Range

Description

Tool to get download counts for an npm package over a specified date range. use when you need historical daily download data.

Action Parameters

end
stringRequired
package
stringRequired
start
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Registry Meta

Description

Tool to get npm registry metadata. use when calling meta sub-endpoints (ping, whoami, all, short) after confirming registry access.

Action Parameters

endpoint
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Package Download Counts

Description

Tool to get download counts for a package over a period. use when you need npm package download metrics for a given period.

Action Parameters

package
stringRequired
period
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Package Metadata

Description

Tool to fetch metadata for a specified npm package. use after confirming the exact package name, including scope.

Action Parameters

package
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Package Version Metadata

Description

Tool to get metadata for a specific package version. use after confirming the exact package name and version.

Action Parameters

package
stringRequired
version
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get NPM Registry Root Metadata

Description

Tool to fetch npm registry root metadata and stats. use when you need to retrieve top-level registry database information such as package counts, sizes, and sequences.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search NPM Packages

Description

Tool to search for packages in the npm registry. use when you need to find packages matching a search term.

Action Parameters

maintenance
numberDefaults to 1
offset
integer
popularity
numberDefaults to 1
quality
numberDefaults to 1
size
integerDefaults to 20
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired