Skip to main content
@outlit/pi registers Outlit customer intelligence tools inside Pi. Use it when you want a Pi agent to query complete customer profiles, timelines, facts, sources, and customer-context search results through Outlit’s public tool gateway.

Install

pi install npm:@outlit/pi
Set an Outlit API key before starting Pi:
export OUTLIT_API_KEY=ok_your_api_key
pi

Default Tools

The default Pi extension exposes the customer intelligence tools that are safe for most agents:
ToolWhat it does
outlit_list_customersBrowse customers by billing status, activity, revenue, traits, or name
outlit_list_usersBrowse contacts by journey stage, activity, customer, traits, email, or name
outlit_get_customerRetrieve one complete customer profile
outlit_get_timelineRetrieve customer activity across product, billing, support, and conversation channels
outlit_list_factsList structured facts with status, source type, date, and provenance filters
outlit_get_factRetrieve one exact fact
outlit_get_sourceRetrieve one exact source record behind a fact or search result
outlit_search_customer_contextSearch grouped source and fact results with natural language
SQL tools are available through @outlit/tools, but they are not enabled by default in @outlit/pi. Use them only for internal agents that should run read-only SQL.

Minimal Extension

If you only need the Outlit tools and the bundled outlit Pi skill, the package default is enough:
import { createOutlitPiExtension } from "@outlit/pi"

export default createOutlitPiExtension()
The extension reads OUTLIT_API_KEY from the environment and uses https://app.outlit.ai by default.

Custom Toolsets

Pass toolNames when you want a narrower or broader toolset:
import { allCustomerToolNames, createOutlitPiExtension } from "@outlit/pi"

export default createOutlitPiExtension({
  toolNames: allCustomerToolNames,
})
allCustomerToolNames includes the SQL tools. Keep integration setup and integration-management actions outside customer-facing Pi agents unless you are building an internal admin package.

Growth Agent Examples

The examples/pi-agents package shows four Pi agents built on @outlit/pi for revenue and retention work. It includes:
  • Outlit customer intelligence, SQL, and schema tools registered in Pi
  • the generic outlit skill from @outlit/pi
  • a shared growth-agent skill with evidence-gathering playbooks
  • slash commands and editable prompt templates for usage decay, friction-to-churn, activation failure, and expansion readiness
Try it locally from the SDK repo:
cd examples/pi-agents
npm install
export OUTLIT_API_KEY=ok_your_api_key
pi install -l .
pi
Then ask:
/outlit-usage-decay-watchtower paying customers over $500 MRR
or:
Which paying customers are active enough to be expansion candidates but blocked by plan limits?

Public Tool Gateway

See the HTTP route and shared @outlit/tools contracts

Agent Skills

Install Outlit guidance for coding agents