### Configure and run the application

Source: https://docs.scalekit.com/cookbooks/litellm-agentkit-inbox-triage

Prepare the environment variables, install dependencies, and start the development server.

```bash
cp .env.example .env
# Fill in the variables above

npm install
npm run dev
```

--------------------------------

### Install Scalekit Go SDK

Source: https://docs.scalekit.com/_llms-txt/integration-guides.txt

Command to install the Scalekit Go SDK via go get.

```bash
go get -u github.com/scalekit-inc/scalekit-sdk-go
```

--------------------------------

### Salesloft Quickstart Integration

Source: https://docs.scalekit.com/agentkit/connectors/salesloft

Complete setup for initializing the Scalekit client, authorizing a user, and executing a tool call in Python.

```python
import os
from scalekit.client import ScalekitClient
from dotenv import load_dotenv
load_dotenv()

scalekit_client = ScalekitClient(
    env_url=os.getenv("SCALEKIT_ENV_URL"),
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
)
actions = scalekit_client.actions

connection_name = "salesloft"
identifier = "user_123"

# Generate an authorization link for the user
link_response = actions.get_authorization_link(
    connection_name=connection_name,
    identifier=identifier,
)
print("Authorize Salesloft:", link_response.link)
input("Press Enter after authorizing...")

# Make your first call
result = actions.execute_tool(
    tool_input={},
    tool_name="salesloft_accounts_list",
    connection_name=connection_name,
    identifier=identifier,
)
print(result)
```

--------------------------------

### runwaremcp_model_examples

Source: https://docs.scalekit.com/agentkit/connectors/runwaremcp

Get sample input/output examples for a curated Runware model.

```APIDOC
## runwaremcp_model_examples

### Description
Get sample input/output examples for a curated Runware model.

### Parameters
#### Query Parameters
- **air** (string) - Required - Model AIR identifier.
- **capability** (string) - Optional - Optional capability filter (e.g. "io:text-to-image").
```

--------------------------------

### Execute Setup and Helm Install

Source: https://docs.scalekit.com/self-hosted/setup-script

Commands to run the generated secrets script and install the Scalekit Helm chart.

```bash
bash $OUTPUT_FILE

helm install scalekit oci://${REGISTRY_SERVER}/scalekit/charts/scalekit \
    --version ${CHART_VERSION} \
    -n ${NAMESPACE} \
    --values=${VALUES_FILE}
```

--------------------------------

### Install and Initialize SDK

Source: https://docs.scalekit.com/agentkit/sdks/python

Installation command and basic client initialization for the Python SDK.

```bash
pip install scalekit-sdk-python
```

```python

from scalekit import ScalekitClient

scalekit_client = ScalekitClient(
    env_url=os.environ["SCALEKIT_ENV_URL"],
    client_id=os.environ["SCALEKIT_CLIENT_ID"],
    client_secret=os.environ["SCALEKIT_CLIENT_SECRET"],
)

actions = scalekit_client.actions
```

--------------------------------

### Run Setup Script

Source: https://docs.scalekit.com/self-hosted/installation

Commands to make the generated setup script executable and run it.

```bash
chmod +x setup-secrets.sh
bash setup-secrets.sh
```

--------------------------------

### Setup Scalekit CLI

Source: https://docs.scalekit.com/agentkit/connected-accounts

Use the npx command for a quick setup of the Scalekit CLI.

```bash
npx @scalekit-inc/cli setup
```

--------------------------------

### Install Scalekit SDK

Source: https://docs.scalekit.com/agentkit/advanced/migrate-from-composio

Install the Scalekit SDK for your preferred programming language.

```bash
pip install scalekit-sdk-python
```

```bash
npm install @scalekit-sdk/node
```

--------------------------------

### Install dependencies

Source: https://docs.scalekit.com/cookbooks/langsmith-tracing-agentkit

Install the required Scalekit, LangChain, and LangSmith packages.

```bash
pip install scalekit-sdk-python langchain-openai langsmith python-dotenv
```

--------------------------------

### Install Scalekit and Firebase Admin SDKs

Source: https://docs.scalekit.com/guides/integrations/auth-systems/firebase

Install the necessary dependencies for the backend server.

```bash
npm install @scalekit-sdk/node firebase-admin
```

--------------------------------

### Install Plugins via Copilot

Source: https://docs.scalekit.com/dev-kit/build-with-ai/full-stack-auth

Manual installation commands for Copilot plugins.

```bash
1copilot plugin marketplace add scalekit-inc/authstack2copilot plugin install agentkit@authstack3copilot plugin install saaskit@authstack
```

--------------------------------

### Install Scalekit and Chargebee SDKs

Source: https://docs.scalekit.com/cookbooks/sync-b2b-billing-with-chargebee

Install the required Node.js packages for the server-side implementation.

```bash
npm install @scalekit-sdk/node chargebee
```

--------------------------------

### Install Python Dependencies

Source: https://docs.scalekit.com/cookbooks/daily-briefing-agent

Commands to set up the virtual environment and install Python dependencies.

```bash
cd python
uv venv .venv
uv pip install -r requirements.txt
```

--------------------------------

### Install LangChain

Source: https://docs.scalekit.com/_llms-txt/agentkit-frameworks.txt

Install the LangChain library to use Scalekit framework adapters.

```bash
1
pip install langchain
```

--------------------------------

### Browse and Install Specific Skills

Source: https://docs.scalekit.com/dev-kit/build-with-ai/full-stack-auth

List available skills or install a specific skill by name.

```bash
# List all available skills
npx skills add scalekit-inc/authstack --list

# Install a specific skill
npx skills add scalekit-inc/authstack --skill adding-mcp-oauth
```

--------------------------------

### Configure and run the sample

Source: https://docs.scalekit.com/_llms-txt/agentkit.txt

Commands to initialize the environment and start the development server.

```bash
cp .env.example .env
# Fill in the variables above


npm install
npm run dev
```

--------------------------------

### Install Scalekit SDK

Source: https://docs.scalekit.com/_llms-txt/mcp-authentication.txt

Commands to install the Scalekit SDK for Node.js or Python environments.

```bash
npm install @scalekit-sdk/node
```

```sh
pip install scalekit-sdk-python
```

--------------------------------

### Initialize project and install dependencies

Source: https://docs.scalekit.com/cookbooks/render-github-pr-summarizer

Run these commands in your terminal to create the project directory, initialize npm, and install the necessary SDKs and development tools.

```bash
mkdir render-pr-summarizer && cd render-pr-summarizer
npm init -y
npm install @renderinc/sdk @scalekit-sdk/node openai dotenv express
npm install -D typescript tsx @types/node @types/express
```

--------------------------------

### Global Scalekit CLI Installation

Source: https://docs.scalekit.com/agentkit/connected-accounts

Install the CLI globally via npm to access the setup command directly.

```bash
npm install -g @scalekit-inc/cli
scalekit setup
```

--------------------------------

### Initialize SDK and List Organizations

Source: https://docs.scalekit.com/_llms-txt/enterprise-sso--scim.txt

Examples for initializing the client and fetching organization data using different interfaces.

```bash
1
# Security: Replace <ACCESS_TOKEN> with a valid access token from Scalekit
2
# This token authorizes your API requests to access organization data
3


4
# Use case: Verify API connectivity and test authentication
5
# Examples: Initial setup testing, debugging integration issues
6


7
curl -L "https://$SCALEKIT_ENVIRONMENT_URL/api/v1/organizations?page_size=5" \
8
-H "Authorization: Bearer <ACCESS_TOKEN>"
```

```javascript
1
import { ScalekitClient } from '@scalekit-sdk/node';
2

3
// Initialize Scalekit client with environment variables
4
// Security: Always use environment variables for sensitive credentials
5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
);
10

11
try {
12
  // Use case: Retrieve organizations for bulk user provisioning workflows
13
  // Examples: Multi-tenant applications, enterprise customer onboarding
14
  const { organizations } = await scalekit.organization.listOrganization({
15
    pageSize: 5,
16
  });
17

18
  console.log(`Organization name: ${organizations[0].display_name}`);
19
  console.log(`Organization ID: ${organizations[0].id}`);
20
} catch (error) {
21
  console.error('Failed to list organizations:', error);
22
  // Handle error appropriately for your application
23
}
```

```python
1
from scalekit import ScalekitClient
2
import os
3

4
# Initialize the SDK client with environment variables
5
# Security: Use os.getenv() to securely access credentials
6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET")
10
)
11

12
try:
13
    # Use case: Sync user data across multiple organizations
14
    # Examples: Scheduled provisioning tasks, HR system integration
15
    org_list = scalekit_client.organization.list_organizations(page_size=100)
```

--------------------------------

### Get role details response example

Source: https://docs.scalekit.com/apis

Example JSON response structure for a successful role retrieval request.

```json
{
  "role": {
    "dependent_roles_count": 2,
    "display_name": "Content Editor",
    "id": "role_1234abcd5678efgh",
    "name": "content_editor",
    "permissions": [
      {
        "name": "read:content"
      }
    ]
  }
}
```

--------------------------------

### List organization roles response example

Source: https://docs.scalekit.com/apis

Example JSON response structure for the GET /api/v1/organizations/{org_id}/roles endpoint.

```json
{
  "roles": [
    {
      "default_creator": true,
      "default_member": true,
      "dependent_roles_count": 3,
      "description": "Can create, edit, and publish content but cannot delete or manage users",
      "display_name": "Content Editor",
      "extends": "admin_role",
      "id": "role_1234abcd5678efgh",
      "is_org_role": true,
      "name": "content_editor",
      "permissions": [
        {
          "description": "Read Content",
          "name": "read:content",
          "role_name": "admin_role"
        },
        {
          "description": "Write Content",
          "name": "write:content",
          "role_name": "editor_role"
        }
      ]
    }
  ]
}
```

--------------------------------

### listenlabsmcp_create_study

Source: https://docs.scalekit.com/agentkit/connectors/listenlabsmcp

Starts a new guided user-interview study.

```APIDOC
## listenlabsmcp_create_study

### Description
Start a new guided user-interview study. Provide a plain-language description of the study goals and target audience.

### Parameters
- **prompt** (string) - Required - Plain-language description of the study to create
- **orgId** (string) - Optional - Organization UUID
- **orgName** (string) - Optional - Organization name
```

--------------------------------

### Verify setup with Go

Source: https://docs.scalekit.com/authenticate/set-up-scalekit

Initialize the Scalekit client and list organizations using the Go SDK.

```go
package main

import (
  "context"
  "fmt"
  "os"
  "github.com/scalekit-inc/scalekit-sdk-go"
)

func main() {
  ctx := context.Background()

  scalekitClient := scalekit.NewScalekitClient(
    os.Getenv("SCALEKIT_ENVIRONMENT_URL"),
    os.Getenv("SCALEKIT_CLIENT_ID"),
    os.Getenv("SCALEKIT_CLIENT_SECRET"),
  )

  organizations, err := scalekitClient.Organization.ListOrganizations(ctx, &scalekit.ListOrganizationsParams{
    PageSize: 5,
  })

  if err != nil {
    panic(err)
  }

  fmt.Printf("Name of the first organization: %s\n", organizations[0].DisplayName)
}
```

--------------------------------

### List Directory Users Response Example

Source: https://docs.scalekit.com/apis

Example JSON response for the GET /api/v1/organizations/{organization_id}/directories/{directory_id}/users endpoint.

```json
{
  "next_page_token": "",
  "prev_page_token": "",
  "total_size": 1,
  "users": [
    {
      "email": "johndoe",
      "emails": [
        ""
      ],
      "family_name": "Doe",
      "given_name": "John",
      "groups": [
        {}
      ],
      "id": "diruser_121312434123312",
      "preferred_username": "johndoe",
      "updated_at": "2024-10-01T00:00:00Z",
      "user_detail": {}
    }
  ]
}
```

--------------------------------

### Verify Setup with Java

Source: https://docs.scalekit.com/_llms-txt/quickstart-collection.txt

Initializes the Java client for verification.

```java
import com.scalekit.ScalekitClient;
import com.scalekit.models.ListOrganizationsResponse;


public class Verify {
  public static void main(String[] args) {
    ScalekitClient scalekitClient = new ScalekitClient(
      System.getenv("SCALEKIT_ENVIRONMENT_URL"),
      System.getenv("SCALEKIT_CLIENT_ID"),
      System.getenv("SCALEKIT_CLIENT_SECRET")
    );
```

--------------------------------

### List Directory Groups Response Example

Source: https://docs.scalekit.com/apis

Example JSON response for the GET /api/v1/organizations/{organization_id}/directories/{directory_id}/groups endpoint.

```json
{
  "groups": [
    {
      "display_name": "Admins",
      "group_detail": {},
      "id": "dirgroup_121312434123312",
      "total_users": 10,
      "updated_at": "2024-10-01T00:00:00Z"
    }
  ],
  "next_page_token": "",
  "prev_page_token": "",
  "total_size": 1
}
```

--------------------------------

### Make Authenticated API Request

Source: https://docs.scalekit.com/saaskit/apis

Example of using the access token to fetch organizations.

```sh
curl https://<SCALEKIT_ENVIRONMENT_URL>/api/v1/organizations \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'
```

--------------------------------

### Install Java SDK

Source: https://docs.scalekit.com/saaskit/apis

Add the Scalekit Java SDK dependency to your project using Gradle or Maven.

```gradle
/* Gradle users - add the following to your dependencies in build file */
implementation "com.scalekit:scalekit-sdk-java:2.0.11"
```

```xml
<!-- Maven users - add the following to your `pom.xml` -->
<dependency>
    <groupId>com.scalekit</groupId>
    <artifactId>scalekit-sdk-java</artifactId>
    <version>2.0.11</version>
</dependency>
```

--------------------------------

### Initialize Environment Variables

Source: https://docs.scalekit.com/authenticate/mcp/fastmcp-quickstart

Copy the example environment file to create a local configuration file.

```bash
cp env.example .env
```

--------------------------------

### gtmetrixmcp_get_test

Source: https://docs.scalekit.com/agentkit/connectors/gtmetrixmcp

Get the current status of a started GTmetrix test.

```APIDOC
## gtmetrixmcp_get_test

### Description
Get the current status of a started GTmetrix test. Long-polls server-side until the test completes or budget expires.

### Parameters
#### Required
- **test_id** (string) - The 8-character test ID returned by gtmetrix_start_test.

#### Optional
- **wait_seconds** (integer) - Number of seconds to wait for the test to complete (0–30). If omitted, returns immediately with current status.
```

--------------------------------

### Install and Initialize Scalekit SDK

Source: https://docs.scalekit.com/agentkit/sdks/node

Install the package via npm and initialize the ScalekitClient using environment variables for credentials.

```bash
npm install @scalekit-sdk/node
```

```typescript
import { ScalekitClient } from '@scalekit-sdk/node';

const scalekit = new ScalekitClient({
  clientId: process.env.SCALEKIT_CLIENT_ID!,
  clientSecret: process.env.SCALEKIT_CLIENT_SECRET!,
  envUrl: process.env.SCALEKIT_ENV_URL!,
});
```

--------------------------------

### cartamcp_welcome

Source: https://docs.scalekit.com/agentkit/connectors/cartamcp

Get a welcome message and orientation guide from Carta MCP.

```APIDOC
## cartamcp_welcome

### Description
Get a welcome message and orientation guide from Carta MCP.
```

--------------------------------

### API Error Response Structure

Source: https://docs.scalekit.com/saaskit/apis

Example of the JSON structure returned by the API when an error occurs.

```json
{
	"code": 16,
	"message": "Token empty",
	"details": [
		{
			"@type": "type.googleapis.com/scalekit.v1.errdetails.ErrorInfo",
			"error_code": "UNAUTHENTICATED"
		}
	]
}
```

--------------------------------

### Verify setup with Python

Source: https://docs.scalekit.com/authenticate/set-up-scalekit

Initialize the Scalekit client and list organizations using the Python SDK.

```python
from scalekit import ScalekitClient
import os

# Initialize the SDK client
scalekit_client = ScalekitClient(
  os.getenv('SCALEKIT_ENVIRONMENT_URL'),
  os.getenv('SCALEKIT_CLIENT_ID'),
  os.getenv('SCALEKIT_CLIENT_SECRET')
)

org_list = scalekit_client.organization.list_organizations(page_size=5)

print(f'Name of the first organization: {org_list[0].display_name}')
```

```bash
python verify.py
```

--------------------------------

### whimsicalmcp_how_to

Source: https://docs.scalekit.com/agentkit/connectors/whimsicalmcp

Look up Whimsical-specific syntax, examples, and guides for creating diagrams and wireframes.

```APIDOC
## whimsicalmcp_how_to

### Description
Look up Whimsical-specific syntax, examples, and guides for creating diagrams and wireframes.

### Parameters
- **domain** (string) - Optional - Structured lookup that returns JSON. When domain is provided, topic is ignored.
- **topic** (string) - Optional - Topic keyword (e.g. 'flowchart', 'table', 'colors') or search query
```

--------------------------------

### mailerlitemcp_start_automation_conversation

Source: https://docs.scalekit.com/agentkit/connectors/mailerlitemcp

Start a guided conversation to help build an automation from a natural language request.

```APIDOC
## mailerlitemcp_start_automation_conversation

### Description
Start a guided conversation to help build an automation from a natural language request.

### Parameters
- **user_request** (string) - Required - What the user asked for
```

--------------------------------

### Initialize Project Directory

Source: https://docs.scalekit.com/_llms-txt/mcp-authentication.txt

Create a new directory and set up a Python virtual environment for the project.

```bash
mkdir fastapi-mcp-python
cd fastapi-mcp-python
python3 -m venv .venv
source .venv/bin/activate
```

--------------------------------

### Pipedrive Quickstart Integration

Source: https://docs.scalekit.com/agentkit/connectors/pipedrive

Complete workflow for initializing the Scalekit client, authorizing a connection, and executing a tool.

```python
import os
from scalekit.client import ScalekitClient
from dotenv import load_dotenv
load_dotenv()

scalekit_client = ScalekitClient(
    env_url=os.getenv("SCALEKIT_ENV_URL"),
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
)
actions = scalekit_client.actions

connection_name = "pipedrive"
identifier = "user_123"

# Generate an authorization link for the user
link_response = actions.get_authorization_link(
    connection_name=connection_name,
    identifier=identifier,
)
print("Authorize Pipedrive:", link_response.link)
input("Press Enter after authorizing...")

# Make your first call
result = actions.execute_tool(
    tool_input={},
    tool_name="pipedrive_activities_list",
    connection_name=connection_name,
    identifier=identifier,
)
print(result)
```

--------------------------------

### Quickstart Authorization and Tool Execution

Source: https://docs.scalekit.com/agentkit/connectors/close

Complete flow for initializing the client, authorizing a user, and executing a tool.

```typescript
1import { ScalekitClient } from '@scalekit-sdk/node'2import 'dotenv/config'3
4const scalekit = new ScalekitClient(5  process.env.SCALEKIT_ENV_URL,6  process.env.SCALEKIT_CLIENT_ID,7  process.env.SCALEKIT_CLIENT_SECRET,8)9const actions = scalekit.actions10
11const connector = 'close'12const identifier = 'user_123'13
14// Generate an authorization link for the user15const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })16console.log('Authorize Close:', link)17process.stdout.write('Press Enter after authorizing...')18await new Promise(r => process.stdin.once('data', r))19
20// Make your first call21const result = await actions.executeTool({22  connector,23  identifier,24  toolName: 'close_activities_list',25  toolInput: {},26})27console.log(result)
```

```python
1import os2from scalekit.client import ScalekitClient3from dotenv import load_dotenv4load_dotenv()
```

--------------------------------

### planetscalemcp_planetscale_search_documentation

Source: https://docs.scalekit.com/agentkit/connectors/planetscalemcp

Search the PlanetScale knowledge base for documentation, API references, code examples, and guides.

```APIDOC
## planetscalemcp_planetscale_search_documentation

### Description
Search the PlanetScale knowledge base for documentation, API references, code examples, and guides.

### Parameters
- **query** (string) - Required - Search query for PlanetScale docs
- **api_reference_only** (boolean) - Optional - Only return API reference docs
- **code_only** (boolean) - Optional - Only return code snippets
- **language** (string) - Optional - Optional language filter (e.g., 'en', 'es')
- **version** (string) - Optional - Optional version filter (e.g., 'v0.7')
```

--------------------------------

### Install and Initialize Scalekit SDK

Source: https://docs.scalekit.com/agentkit/sdks/python

Install the package via pip and initialize the client using environment variables.

```bash
pip install scalekit-sdk-python
```

```python
import os
from scalekit import ScalekitClient

scalekit_client = ScalekitClient(
    env_url=os.environ["SCALEKIT_ENV_URL"],
    client_id=os.environ["SCALEKIT_CLIENT_ID"],
    client_secret=os.environ["SCALEKIT_CLIENT_SECRET"],
)

actions = scalekit_client.actions
```

--------------------------------

### kitmcp_list_prompt_suggestions

Source: https://docs.scalekit.com/agentkit/connectors/kitmcp

Retrieve suggested prompts to help the user get started with Kit via AI.

```APIDOC
## kitmcp_list_prompt_suggestions

### Description
Retrieve suggested prompts to help the user get started with Kit via AI.

### Parameters
- **session_id** (string) - Optional - UUID v4 identifier for grouping tool calls in the same conversation.
- **user_goal** (string) - Optional - What the creator is trying to accomplish with this tool call.
```

--------------------------------

### Verify setup with Java

Source: https://docs.scalekit.com/authenticate/set-up-scalekit

Initialize the Scalekit client and list organizations using the Java SDK.

```java
import com.scalekit.ScalekitClient;
import com.scalekit.models.ListOrganizationsResponse;

public class Verify {
  public static void main(String[] args) {
    ScalekitClient scalekitClient = new ScalekitClient(
      System.getenv("SCALEKIT_ENVIRONMENT_URL"),
      System.getenv("SCALEKIT_CLIENT_ID"),
      System.getenv("SCALEKIT_CLIENT_SECRET")
    );

    ListOrganizationsResponse organizations = scalekitClient.organizations().listOrganizations(5, "");
    System.out.println("Name of the first organization: " + organizations.getOrganizations()[0].getDisplayName());
  }
}
```

--------------------------------

### bitlymcp_get_group_details

Source: https://docs.scalekit.com/agentkit/connectors/bitlymcp

Get metadata for a specific group by GUID, including name, organization, creation date, and BSDs.

```APIDOC
## bitlymcp_get_group_details

### Description
Get metadata for a specific group by GUID, including name, organization, creation date, and BSDs.

### Parameters
- **group_guid** (string) - Required - The unique identifier of the group (workspace)
- **_meta** (object) - Optional - Optional metadata about this request. Include user_prompt, caller_agent (e.g. claude), intent_classification, conversation_id.
- **response_format** (string) - Optional - 'text' (default) or 'json'
```

--------------------------------

### Verify Setup with Go

Source: https://docs.scalekit.com/_llms-txt/quickstart-collection.txt

Lists organizations using the Go SDK to verify configuration.

```go
package main


import (
  "context"
  "fmt"
  "os"
  "github.com/scalekit-inc/scalekit-sdk-go"
)


func main() {
  ctx := context.Background()


  scalekitClient := scalekit.NewScalekitClient(
    os.Getenv("SCALEKIT_ENVIRONMENT_URL"),
    os.Getenv("SCALEKIT_CLIENT_ID"),
    os.Getenv("SCALEKIT_CLIENT_SECRET"),
  )


  organizations, err := scalekitClient.Organization.ListOrganizations(ctx, &scalekit.ListOrganizationsParams{
    PageSize: 5,
  })


  if err != nil {
    panic(err)
  }


  fmt.Printf("Name of the first organization: %s\n", organizations[0].DisplayName)
}
```

--------------------------------

### pendomcp_guidemetrics

Source: https://docs.scalekit.com/agentkit/connectors/pendomcp

Get performance metrics for a single guide over a date range, including reach, views, and completion rates.

```APIDOC
## pendomcp_guidemetrics

### Description
Get performance metrics for a single guide over a date range, including reach, views, and completion rates.

### Parameters
- **endDate** (string) - Required - Query end date in YYYY-MM-DD format.
- **guideId** (string) - Required - The exact guide ID to analyze.
- **startDate** (string) - Required - Query start date in YYYY-MM-DD format.
- **subId** (string) - Required - Subscription ID that owns the data.
- **blacklist** (string) - Optional - Blacklist behavior: 'apply', 'ignore', or 'only'.
- **period** (string) - Optional - Aggregation period: dayRange, day, week, month.
- **userQuery** (string) - Optional - The original user query or question that triggered this tool call.
```

--------------------------------

### Agent prompt examples

Source: https://docs.scalekit.com/dev-kit/cli

Use these prompts within your AI coding agent to trigger AgentKit or SaaSKit skills after setup.

```text
I want to add agent auth to my project. Help me get started with AgentKit.
```

```text
Add enterprise SSO to my Next.js app using SaaSKit.
```

--------------------------------

### Setup Context7 CLI

Source: https://docs.scalekit.com/_llms-txt/agentkit.txt

Initializes the CLI tool with automatic confirmation.

```bash
ctx7 setup --cli --yes
```

--------------------------------

### Retrieve organization directories JSON response

Source: https://docs.scalekit.com/apis

Example JSON response structure for a successful GET request to the directories endpoint.

```json
{
  "directories": [
    {
      "attribute_mappings": null,
      "directory_endpoint": "https://yourapp.scalekit.com/api/v1/directoies/dir_123212312/scim/v2",
      "directory_provider": "OKTA",
      "directory_type": "SCIM",
      "email": "john.doe@scalekit.cloud",
      "enabled": true,
      "groups_tracked": "ALL",
      "id": "dir_121312434123312",
      "last_synced_at": "2024-10-01T00:00:00Z",
      "name": "Azure AD",
      "organization_id": "org_121312434123312",
      "role_assignments": null,
      "secrets": [
        {}
      ],
      "stats": null,
      "status": "IN_PROGRESS",
      "total_groups": 10,
      "total_users": 10
    }
  ]
}
```

--------------------------------

### View standard user profile attributes

Source: https://docs.scalekit.com/_llms-txt/saaskit-complete.txt

Example of a standard user profile object returned by the Get User API.

```json
1
{
2
  "id": "usp_96194455173923084",     // Unique user identifier
3
  "first_name": "John",              // User's given name
4
  "last_name": "Doe",                // User's family name
5
  "name": "John Doe",                // Full name for UI display
6
  "locale": "en-US",                 // User's language and region preference
7
  "email_verified": true,            // Whether the email address has been confirmed
8
  "phone_number": "+14155552671",    // Contact phone number
9
  "metadata": { }, // Additional, non-structured user data
10
  "custom_attributes": {} // Business-specific user data
11
}
```

--------------------------------

### Initialize Scalekit Client for Exa

Source: https://docs.scalekit.com/agentkit/connectors/exa

Setup the Scalekit client and execute a basic tool call to list websets.

```python
scalekit_client = ScalekitClient(
    env_url=os.getenv("SCALEKIT_ENV_URL"),
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
)
actions = scalekit_client.actions

connection_name = "exa"
identifier = "user_123"

# Make your first call
result = actions.execute_tool(
    tool_input={},
    tool_name="exa_list_websets",
    connection_name=connection_name,
    identifier=identifier,
)
print(result)
```

--------------------------------

### Install and Initialize Node.js SDK

Source: https://docs.scalekit.com/agentkit/sdks/node

Installation command and client initialization pattern for the Scalekit Node.js SDK.

```bash
npm install @scalekit-sdk/node
```

```typescript
const scalekit = new ScalekitClient({
  clientId: process.env.SCALEKIT_CLIENT_ID!,
  clientSecret: process.env.SCALEKIT_CLIENT_SECRET!,
  envUrl: process.env.SCALEKIT_ENV_URL!,
});
```

--------------------------------

### bitlymcp_get_user

Source: https://docs.scalekit.com/agentkit/connectors/bitlymcp

Get the authenticated user's profile including email addresses, 2FA status, and default group GUID.

```APIDOC
## bitlymcp_get_user

### Description
Get the authenticated user's profile including email addresses, 2FA status, and default group GUID.

### Parameters
#### Request Body
- **_meta** (object) - Optional - Optional metadata about this request. Include user_prompt, caller_agent (e.g. claude), intent_classification, conversation_id.
- **response_format** (string) - Optional - 'text' (default) or 'json'
```

--------------------------------

### Run the Server

Source: https://docs.scalekit.com/authenticate/mcp/fastmcp-quickstart

Execute the server instance to start listening for requests.

```python
if __name__ == "__main__":
    mcp.run()
```

--------------------------------

### Migration Example

Source: https://docs.scalekit.com/sdks/go

Demonstrates that no code changes are required for existing implementations.

```go
// Existing code - no changes needed
domains, err := client.Domain().ListDomains(ctx, organizationId)
```

--------------------------------

### Execute Evaluation Flow

Source: https://docs.scalekit.com/self-hosted/setup-script

Handles the automated setup for evaluation mode, including secret collection, values.yaml generation, and Helm installation.

```bash
if [[ "$ENV_CHOICE" == "4" ]]; then
  header "Step 2 — Evaluation setup"
  dim "  Helm will spin up PostgreSQL and Redis automatically."
  dim "  You only need a Svix API token and registry credentials."
  echo

  ask_secret SVIX_JWT_SECRET   "  Svix JWT secret (must be the secret used to sign the API token)"
  ask_secret SVIX_API_KEY      "  Svix API token (JWT signed with the above secret)"
  ask_secret REGISTRY_PASSWORD "  Registry access token"
  echo

  VALUES_FILE="$(pwd)/values-eval-$(date +%Y%m%d%H%M%S).yaml"
  cat > "$VALUES_FILE" <<EOF
secrets:
  create: true
  svix:
    jwtSecret: "${SVIX_JWT_SECRET}"
    apiToken: "${SVIX_API_KEY}"
  registry:
    password: "${REGISTRY_PASSWORD}"

postgresql:
  enabled: true

redis:
  enabled: true
EOF

  success "values.yaml written to: $VALUES_FILE"
  echo

  header "Step 3 — Helm install"
  ask CHART_VERSION "  Chart version to install (e.g. 0.1.0)"
  echo

  header "Done"
  echo
  success "values.yaml : $VALUES_FILE"
  echo
  echo -e "${BOLD}${CYAN}┌─────────────────────────────────────────────────────────────┐${RESET}"
  echo -e "${BOLD}${CYAN}│              execute the following command                   │${RESET}"
  echo -e "${BOLD}${CYAN}└─────────────────────────────────────────────────────────────┘${RESET}"
  echo
  echo "  helm install scalekit oci://${REGISTRY_SERVER}/scalekit/charts/scalekit \"
  echo "    --version ${CHART_VERSION} \"
  echo "    -n ${NAMESPACE} \"
  echo "    --values=${VALUES_FILE}"
  echo
  echo -e "${BOLD}${CYAN}└─────────────────────────────────────────────────────────────┘${RESET}"
  exit 0
fi
```

--------------------------------

### Retrieve user count for role response

Source: https://docs.scalekit.com/apis

Example JSON response structure for the GET /api/v1/roles/{role_name}/users:count endpoint.

```json
{
  "count": 10
}
```

--------------------------------

### Target specific AI tools for setup

Source: https://docs.scalekit.com/dev-kit/cli

Pass the tool name as an argument to skip the interactive wizard and install directly for a specific agent.

```bash
scalekit setup cursor
scalekit setup claude      # aliases: claude-code, cc
scalekit setup codex       # alias: opencode
scalekit setup copilot     # aliases: github-copilot, ghcp
```

--------------------------------

### Verify Setup with Python

Source: https://docs.scalekit.com/_llms-txt/quickstart-collection.txt

Lists organizations using the Python SDK to verify configuration.

```python
from scalekit import ScalekitClient
import os


# Initialize the SDK client
scalekit_client = ScalekitClient(
  os.getenv('SCALEKIT_ENVIRONMENT_URL'),
  os.getenv('SCALEKIT_CLIENT_ID'),
  os.getenv('SCALEKIT_CLIENT_SECRET')
)


org_list = scalekit_client.organization.list_organizations(page_size=5)


print(f'Name of the first organization: {org_list[0].display_name}')
```

--------------------------------

### List user's passkeys response structure

Source: https://docs.scalekit.com/apis

Example JSON response for the GET /api/v1/webauthn/credentials endpoint, showing the structure of accepted credential options and registered passkeys.

```json
{
  "all_accepted_credentials_options": {
    "all_accepted_credential_ids": [
      ""
    ],
    "rp_id": "example.com",
    "user_id": "user_xyz789"
  },
  "credentials": [
    {
      "attestation_type": "direct",
      "authenticator": null,
      "authenticator_flags": null,
      "client_info": null,
      "created_at": "2025-02-15T06:23:44.560000Z",
      "credential_id": "",
      "display_name": "My Yubikey",
      "id": "cred_abc123",
      "transports": [
        ""
      ],
      "updated_at": "2025-02-15T06:23:44.560000Z",
      "user_agent": null,
      "user_id": "user_xyz789"
    }
  ]
}
```

--------------------------------

### Settings configuration examples for mondaymcp_createviewtable

Source: https://docs.scalekit.com/agentkit/connectors/mondaymcp

Examples of column properties and group-by settings for configuring table-type board views.

```json
{ "column_properties": [{ "column_id": "status", "visible": true }], "column_order": ["name", "status", "date"] }
```

```json
{ "conditions": [{ "columnId": "status" }], "hideEmptyGroups": true }
```

--------------------------------

### Generate SSO Authorization URL

Source: https://docs.scalekit.com/sso/quickstart

Use these examples to generate the URL required to start the SSO authentication process. Ensure the redirect_uri matches the one configured in your Scalekit dashboard.

```javascript
import { Scalekit } from '@scalekit-sdk/node';

const scalekit = new ScalekitClient(
  '',    // Your Scalekit environment URL
  '',          // Unique identifier for your app
  '',
);

const options = {};

// Specify which SSO connection to use (choose one based on your use case)
// These identifiers are evaluated in order of precedence:

// 1. connectionId (highest precedence) - Use when you know the exact SSO connection
options['connectionId'] = 'conn_15696105471768821';

// 2. organizationId - Routes to organization's SSO (useful for multi-tenant apps)
//    If org has multiple connections, the first active one is selected
options['organizationId'] = 'org_15421144869927830';

// 3. loginHint (lowest precedence) - Extracts domain from email to find connection
//    Domain must be registered to the organization (manually via Dashboard or through admin portal during enterprise onboarding)
options['loginHint'] = 'user@example.com';

// redirect_uri: Your callback endpoint that receives the authorization code
// Must match the URL registered in your Scalekit dashboard
const redirectUrl = 'https://your-app.com/auth/callback';

const authorizationURL = scalekit.getAuthorizationUrl(redirectUrl, options);
// Redirect user to this URL to begin SSO authentication
```

```python
from scalekit import ScalekitClient, AuthorizationUrlOptions

scalekit = ScalekitClient(
  '',    # Your Scalekit environment URL
  '',          # Unique identifier for your app
  ''
)

options = AuthorizationUrlOptions()

# Specify which SSO connection to use (choose one based on your use case)
# These identifiers are evaluated in order of precedence:

# 1. connection_id (highest precedence) - Use when you know the exact SSO connection
options.connection_id = 'conn_15696105471768821'

# 2. organization_id - Routes to organization's SSO (useful for multi-tenant apps)
#    If org has multiple connections, the first active one is selected
options.organization_id = 'org_15421144869927830'

# 3. login_hint (lowest precedence) - Extracts domain from email to find connection
#    Domain must be registered to the organization (manually via Dashboard or through admin portal during enterprise onboarding)
options.login_hint = 'user@example.com'

# redirect_uri: Your callback endpoint that receives the authorization code
# Must match the URL registered in your Scalekit dashboard
redirect_uri = 'https://your-app.com/auth/callback'

authorization_url = scalekit_client.get_authorization_url(
  redirect_uri=redirect_uri,
  options=options
)
# Redirect user to this URL to begin SSO authentication
```

```go
import (
  "github.com/scalekit-inc/scalekit-sdk-go"
)

func main() {
  scalekitClient := scalekit.NewScalekitClient(
    "",  // Your Scalekit environment URL
    "",        // Unique identifier for your app
    ""
  )

  options := scalekitClient.AuthorizationUrlOptions{}

  // Specify which SSO connection to use (choose one based on your use case)
  // These identifiers are evaluated in order of precedence:

  // 1. ConnectionId (highest precedence) - Use when you know the exact SSO connection
  options.ConnectionId = "conn_15696105471768821"

  // 2. OrganizationId - Routes to organization's SSO (useful for multi-tenant apps)
  //    If org has multiple connections, the first active one is selected
  options.OrganizationId = "org_15421144869927830"

  // 3. LoginHint (lowest precedence) - Extracts domain from email to find connection
  //    Domain must be registered to the organization (manually via Dashboard or through admin portal during enterprise onboarding)
  options.LoginHint = "user@example.com"

  // redirectUrl: Your callback endpoint that receives the authorization code
  // Must match the URL registered in your Scalekit dashboard
  redirectUrl := "https://your-app.com/auth/callback"

  authorizationURL := scalekitClient.GetAuthorizationUrl(
    redirectUrl,
    options,
  )
  // Redirect user to this URL to begin SSO authentication
}
```

--------------------------------

### scalekit setup

Source: https://docs.scalekit.com/dev-kit/cli

Installs the authstack plugin for one or all detected coding agents. Running without arguments launches an interactive wizard, while providing a tool name targets a specific agent.

```APIDOC
## CLI Command: scalekit setup [tool]

### Description
Installs the authstack plugin for one or all detected coding agents. The command detects installed tools and configures them automatically.

### Arguments
- **[tool]** (string) - Optional - Target a specific agent: `cursor`, `claude`, `codex`, `copilot` (and their aliases). Omit to run the interactive wizard.

### Flags
- **-y, --yes** (boolean) - Optional - Skip confirmation prompts.
- **--dry-run** (boolean) - Optional - Print the commands that would run without executing them.
- **--skip-skills** (boolean) - Optional - Skip installing generic Scalekit skills (installs the plugin only).
```

--------------------------------

### Verify setup with Node.js

Source: https://docs.scalekit.com/authenticate/set-up-scalekit

Initialize the Scalekit client and list organizations using the Node.js SDK.

```javascript
import { ScalekitClient } from '@scalekit-sdk/node';

const scalekit = new ScalekitClient(
  process.env.SCALEKIT_ENVIRONMENT_URL,
  process.env.SCALEKIT_CLIENT_ID,
  process.env.SCALEKIT_CLIENT_SECRET,
);

const { organizations } = await scalekit.organization.listOrganization({
  pageSize: 5,
});

console.log(`Name of the first organization: ${organizations[0].display_name}`);
```

```bash
node verify.js
```

--------------------------------

### Clone the sample repository

Source: https://docs.scalekit.com/cookbooks/litellm-agentkit-inbox-triage

Download the project source code and navigate into the directory.

```bash
git clone https://github.com/scalekit-developers/litellm-agentkit-inbox-triage.git
cd litellm-agentkit-inbox-triage
```

--------------------------------

### Install Dependencies

Source: https://docs.scalekit.com/cookbooks/schedule-meeting-and-draft-email

Install the necessary Python packages for the agent.

```bash
pip install scalekit-sdk python-dotenv requests
```

--------------------------------

### Start and Test Server

Source: https://docs.scalekit.com/_llms-txt/mcp-authentication.txt

Commands to run the development server and verify the connection with the MCP Inspector.

```bash
npm run dev
```

```plaintext
✔ MCP Server running on http://127.0.0.1:3001/mcp
[Scalekit] Resolved JWKS URI: https://<your-env>.scalekit.com/keys
```

```bash
npx @modelcontextprotocol/inspector@latest
```

```bash
curl -s -X POST "$SCALEKIT_ENVIRONMENT_URL/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials\
```

--------------------------------

### Install FastMCP

Source: https://docs.scalekit.com/authenticate/mcp/fastmcp-quickstart

Install the FastMCP library using pip.

```bash
pip install fastmcp
```

--------------------------------

### Install Dependencies

Source: https://docs.scalekit.com/_llms-txt/mcp-authentication.txt

Install the project dependencies using npm.

```bash
npm install
```

--------------------------------

### Install Project Dependencies

Source: https://docs.scalekit.com/_llms-txt/mcp-authentication.txt

Create a requirements.txt file and install the necessary packages for FastAPI, FastMCP, and Scalekit integration.

```bash
cat <<'EOF' > requirements.txt
mcp>=1.0.0
fastapi>=0.104.0
fastmcp>=0.8.0
uvicorn>=0.24.0
pydantic>=2.5.0
python-dotenv>=1.0.0
httpx>=0.25.0
python-jose[cryptography]>=3.3.0
cryptography>=41.0.0
scalekit-sdk-python>=2.4.0
starlette>=0.27.0
EOF

pip install -r requirements.txt
```

--------------------------------

### Initialize and Execute Tool in Python

Source: https://docs.scalekit.com/agentkit/connectors/chilipipermcp

Full setup for the Scalekit client and executing a tool in Python.

```python
import os
from scalekit.client import ScalekitClient
from dotenv import load_dotenv
load_dotenv()

scalekit_client = ScalekitClient(
    env_url=os.getenv("SCALEKIT_ENV_URL"),
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
)
actions = scalekit_client.actions

connection_name = "chilipipermcp"
identifier = "user_123"

# Make your first call
result = actions.execute_tool(
    tool_input={},
    tool_name="chilipipermcp_concierge-list-routers",
    connection_name=connection_name,
    identifier=identifier,
)
print(result)
```

--------------------------------

### Initialize FastMCP Project

Source: https://docs.scalekit.com/_llms-txt/mcp-authentication.txt

Commands to create a project directory and set up a Python virtual environment.

```bash
mkdir -p fastmcp-todo
cd fastmcp-todo
python3 -m venv venv
source venv/bin/activate
```