Stainless

https://www.stainless.com/docs
Admin
Stainless generates SDKs, API documentation, CLI tools, MCP servers, and Terraform providers from...
Tokens:209,451
Snippets:1,877
Trust Score:9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Stainless stainless.yml configuration example

Source: https://www.stainless.com/docs/migrate/fern-sdks

Example Stainless stainless.yml configuration showing organization, targets, environments, client settings, resources, and pagination setup.

```yaml
# yaml-language-server: $schema=https://app.stainless.com/config.schema.json
organization:
  name: example
  docs: 'docs.example.com'
  contact: 'support@example.com'


targets:
  typescript:
    package_name: example
    production_repo: example/example-typescript
    publish:
      npm: true


environments:
  production: https://example.com/api/v1


client_settings:
  opts:
    api_key:
      read_env: API_KEY
      auth:
        security_scheme: api_key


resources:
  activities:
    methods:
      list: get /activities
  # ...


pagination:
  - name: limit_start_pagination
    type: offset
    request:
    # ...

```

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

### Install CLI with go install

Source: https://www.stainless.com/docs/cli

Build and install the CLI to your Go bin directory.

```bash
go install ./cmd/my-tool
```

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

### Complete global sidebar configuration with nested items and autogenerate

Source: https://www.stainless.com/docs/docs-platform/navigation

A more complete example of a global sidebar. It includes an index page, quickstart, installation items, an API reference generated by generateAPIReferenceItems(), an autogenerated guides directory, and a resources section with external links and a FAQ slug.

```javascript
import { defineConfig } from "astro/config";
import {
  generateAPIReferenceItems,
  stainlessDocs,
} from "@stainless-api/docs";


export default defineConfig({
integrations: [
  stainlessDocs({
    // ...
      sidebar: [
            "", // index page
            "quickstart",
            {
              label: "Installation",
              items: [
                "installation/macos",
                "installation/windows",
                "installation/linux",
              ],
            },
            {
              label: "API Reference",
              // returns an array of sidebar items for all API methods
              items: generateAPIReferenceItems(),
            },
            {
              label: "Guides",
              // generates items from pages in the 'guides' directory
              autogenerate: { directory: "guides" },
            },
            {
              label: "Resources",
              items: [
                {
                  label: "Community",
                  link: "https://example.com/community", // external link
                },
                {
                  label: "Support",
                  link: "https://example.com/support",
                },
                {
                  label: "FAQ",
                  slug: "faq", // slug is the slug of a page in the docs content collection
                },
              ],
            },
          ],
        }),
      ],
    });

```

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

### Configure readme example requests

Source: https://www.stainless.com/docs/sdks/configure/readme

YAML configuration for the readme section in a generated SDK. The headline example is the first usage shown in the README, the pagination example is required if pagination is configured, and the default example is inherited by all other example requests unless overridden.

```yaml
readme:
  example_requests:
    default:
      type: request
      endpoint: post /cards
      params:
        type: SINGLE_USE
    headline:
      type: request
      endpoint: put /cards
      params:
        type: SINGLE_USE
        account_id: 123
    pagination:
      type: request
      endpoint: get /cards
      params:
        limit: 30

```

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

### Install Stainless CLI with Go

Source: https://www.stainless.com/docs/tools/stainless-language-server

Alternative installation method using Go's install command.

```bash
go install 'github.com/stainless-api/stainless-api-cli/cmd/stl@latest'
```

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

### Install CLI with Go

Source: https://www.stainless.com/docs/cli

Install the CLI directly with Go for Go users.

```bash
go install github.com/your-org/your-tool/cmd/your-tool@latest
```

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

### More complex tabs configuration with sidebars and external links

Source: https://www.stainless.com/docs/docs-platform/navigation

Shows a more complex `tabs` configuration with three tabs: 'Guides', 'Reference', and 'Support'. The 'Guides' tab includes a sidebar with index page, quickstart, installation items, autogenerated guides, and resources with external links. The 'Reference' tab uses `generateAPIReferenceItems()` directly as its sidebar.

```javascript
// ...
tabs: [
  {
    label: "Guides",
    link: "/guides",
    sidebar: [
      "", // index page
      "quickstart",
      {
        label: "Installation",
        items: [
          "installation/macos",
          "installation/windows",
          "installation/linux",
        ],
      },
      {
        label: "Guides",
        autogenerate: { directory: "guides" },
      },
      {
        label: "Resources",
        items: [
          {
            label: "Community",
            link: "https://example.com/community", // external link
          },
          {
            label: "Support",
            link: "https://example.com/support",
          },
          {
            label: "FAQ",
            slug: "faq", // slug is the slug of a page in the docs content collection
          },
        ],
      },
    ],
  },
  {
    label: "Reference",
    link: "/api",
    sidebar: generateAPIReferenceItems(),
  },
  {
    label: "Support",
    link: "https://example.com/support",
  },
],
// ...
```

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

### Install dependencies and build the SDK

Source: https://www.stainless.com/docs/sdks/typescript

Run these commands in the SDK's production repository to install dependencies and build the SDK before publishing.

```bash
pnpm install
pnpm build

```

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

### setup-notarize.sh: configure GitHub secrets for Apple notarization

Source: https://www.stainless.com/docs/cli

Automated setup script that configures a GitHub repository with Apple notarization secrets for GoReleaser. By default it stores secrets in a GitHub environment named 'production'; pass an environment name or an empty string for plain repository secrets. Requires the GitHub CLI to be installed and authenticated, and it validates the .p12 password with openssl.

```bash
#!/usr/bin/env bash
# Configure a GitHub repository with Apple notarization secrets for GoReleaser.
#
# Usage:
#   ./setup-notarize.sh [OWNER/REPO] [ENVIRONMENT]
#
# If OWNER/REPO is omitted, the current git remote origin is used.
# If ENVIRONMENT is omitted, defaults to 'production'. Pass "" to store
# secrets as plain repository secrets instead of environment-scoped.
# Requires the `gh` CLI to be authenticated.


set -euo pipefail


# ── helpers ──────────────────────────────────────────────────────────────────


die()  { echo "error: $*" >&2; exit 1; }
info() { echo "  $*"; }
ask()      { printf "%s: " "$1" >&2; read -r  REPLY; echo "${REPLY/#\~/$HOME}"; }
ask_path() { printf "%s: " "$1" >&2; read -re REPLY; echo "${REPLY/#\~/$HOME}"; }
ask_secret() {
    printf "%s: " "$1" >&2
    read -rs REPLY
    echo >&2
    echo "$REPLY"
}


# ── repo detection ────────────────────────────────────────────────────────────


if [[ $# -ge 1 ]]; then
    REPO="$1"
else
    REMOTE=$(git remote get-url origin 2>/dev/null) || die "No git remote 'origin' found and no OWNER/REPO argument given."
    # Normalize SSH or HTTPS URL → owner/repo
    REPO=$(echo "$REMOTE" \
        | sed -E 's|git@github\.com:||; s|https://github\.com/||; s|\.git$||')
fi


[[ "$REPO" == */* ]] || die "Could not parse a valid OWNER/REPO from: $REPO"


ENV_NAME="${2-production}"


# ── confirm gh is available and authed ───────────────────────────────────────


command -v gh &>/dev/null || die "'gh' CLI not found. Install it: https://cli.github.com"
gh auth status &>/dev/null  || die "Not logged in to GitHub. Run: gh auth login"


# ── ensure environment exists (if requested) ─────────────────────────────────


if [[ -n "$ENV_NAME" ]]; then
    gh api -X PUT "/repos/$REPO/environments/$ENV_NAME" >/dev/null \
        || die "Failed to create or access environment '$ENV_NAME' on $REPO."
    SCOPE_DESC="environment '$ENV_NAME'"
else
    SCOPE_DESC="repository secrets"
fi


cat <<END


Setting up Apple notarization secrets for: $REPO
Scope: $SCOPE_DESC


END


# ── collect credentials ───────────────────────────────────────────────────────


cat <<END
Step 1 of 3 — Signing certificate (.p12)
  Export your 'Developer ID Application' certificate from Keychain Access
  as a .p12 file, then supply the path and its password below.


END


P12_PATH=$(ask_path "  Path to .p12 file")
[[ -f "$P12_PATH" ]] || die "File not found: $P12_PATH"
MACOS_SIGN_P12=$(base64 < "$P12_PATH")
MACOS_SIGN_PASSWORD=$(ask_secret "  .p12 password (hidden)")
openssl pkcs12 -in "$P12_PATH" -passin "pass:$MACOS_SIGN_PASSWORD" -noout 2>/dev/null \
    || die "Could not open .p12 with that password — check the file and password and try again."


cat <<END


Step 2 of 3 — App Store Connect API key (.p8)
  Create an API key at https://appstoreconnect.apple.com/access/api
  with 'Developer' role. Download the .p8 file.


END


P8_PATH=$(ask_path "  Path to .p8 file")
[[ -f "$P8_PATH" ]] || die "File not found: $P8_PATH"
MACOS_NOTARY_KEY=$(base64 < "$P8_PATH")
_p8_base=$(basename "$P8_PATH" .p8)
if [[ "$_p8_base" == AuthKey_* ]]; then
    MACOS_NOTARY_KEY_ID="${_p8_base#AuthKey_}"
    info "Key ID detected from filename: $MACOS_NOTARY_KEY_ID"
else
    MACOS_NOTARY_KEY_ID=$(ask "  Key ID (10-character identifier from App Store Connect)")
fi
MACOS_NOTARY_ISSUER_ID=$(ask "  Issuer ID (UUID shown on the API Keys page)")


cat <<END


Step 3 of 3 — Uploading secrets to GitHub...


END


set_secret() {
    local name="$1"
    local value="$2"
    printf "  %-30s" "$name"
    local args=(--repo "$REPO")
    [[ -n "$ENV_NAME" ]] && args+=(--env "$ENV_NAME")
    if printf '%s' "$value" | gh secret set "$name" "${args[@]}" --body - >/dev/null; then
        echo "set"
    else
        echo "FAILED"
        return 1
    fi
}
```

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

### Install command for early access SDK

Source: https://www.stainless.com/docs/sdks/test/branches

Install command found in the 'Upload tarball' build log on GitHub, used to provide early access users with an install command for the SDK build.

```text
Uploaded build to Stainless storage.
Installation: npm install 'https://pkg.stainless.com/s/your-early-access-branch/123...'
```

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

### Install CLI after Homebrew publishing

Source: https://www.stainless.com/docs/cli

Install the CLI after publishing, either by tapping the repository first or using the concise form.

```bash
brew tap your-org/tools
brew install your-tool
# or more concise:
brew install your-org/tools/your-tool
```

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

### Install the CLI with Homebrew

Source: https://www.stainless.com/docs/quickstart-cli

Installs the Stainless CLI via Homebrew tap. Requires Homebrew to be installed.

```bash
brew install stainless-api/tap/stl
```

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

### Install CLI with Homebrew

Source: https://www.stainless.com/docs/cli

Install the CLI via Homebrew on macOS/Linux. Recommended for most users.

```bash
brew install your-org/tools/your-tool
```

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

### Install dependencies with pnpm

Source: https://www.stainless.com/docs/docs-platform/quickstart

Run inside your site's directory to install required dependencies.

```bash
pnpm install

```

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

### Stainless configuration example

Source: https://www.stainless.com/docs/cli

Example Stainless configuration defining resources and methods for the CLI.

```yaml
resources:
  $client:
    methods:
      current_status: get /status
  people:
    methods:
      retrieve: get /person/{id}
      create: post /person
      list: get /people
```

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

### Install @takumi-rs/image-response

Source: https://www.stainless.com/docs/docs-platform/customization/opengraph-images

Install the required package for Open Graph image generation.

```bash
pnpm i @takumi-rs/image-response
```

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

### Check Go version

Source: https://www.stainless.com/docs/cli

Verify that Go 1.22 or later is installed before testing or installing the CLI locally.

```bash
go version
# go version go1.22.0 darwin/arm64
```

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

### Install Stainless language server globally

Source: https://www.stainless.com/docs/tools/stainless-language-server

Installs the @stainless-api/stainless-language-server package globally via npm.

```bash
npm install -g @stainless-api/stainless-language-server
```

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

### Install Stainless CLI with Homebrew

Source: https://www.stainless.com/docs/docs-platform/quickstart

Install the Stainless CLI using Homebrew. Requires Node.js v22+ and a Stainless account.

```bash
brew install stainless-api/tap/stl

```

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

### x-stainless-examples example

Source: https://www.stainless.com/docs/openapi/extensions

Provides custom code sample examples for an operation, appearing in generated API documentation. Can be an object or array.

```yaml
paths:
  /accounts:
    get:
      x-stainless-examples:
        title: List active accounts
        request:
          python: |
            client.accounts.list(status="active")
          node: |
            await client.accounts.list({ status: 'active' });
        response: |
          [{"id": "acc_123", "name": "Acme Corp", "status": "active"}]

```

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

### Run setup-notarize.sh with repository and optional environment

Source: https://www.stainless.com/docs/cli

Run the setup-notarize.sh script with a repository name. Optionally pass an environment name or an empty string to store secrets as plain repository secrets instead of environment-scoped. Requires the GitHub CLI to be installed and authenticated.

```bash
bash ./setup-notarize.sh org/repo
# or pick a different environment:
bash ./setup-notarize.sh org/repo staging
# or store as plain repository secrets:
bash ./setup-notarize.sh org/repo ""
```

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

### Fern generators.yml configuration example

Source: https://www.stainless.com/docs/migrate/fern-sdks

Example Fern generators.yml configuration showing API spec setup with OpenAPI, origin, overrides, namespace, and settings for schema handling, filtering, and example generation.

```yaml
api:
  specs:
    - openapi: "./openapi.yml"
      origin: "https://api.example.com/openapi.json"
      overrides: "./openapi-overrides.yml"
      namespace: "v1"
      settings:
        title-as-schema-name: true
        inline-path-parameters: false
        inline-all-of-schemas: true
        prefer-undiscriminated-unions-with-literals: true
        filter:
          endpoints: ["POST /users", "GET /users/{id}"]
        example-generation:
          request:
            max-depth: 2

```

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

### MCP server flags: --allow-http-gets, --allowed-methods, --blocked-methods

Source: https://www.stainless.com/docs/mcp/permissions

Pass command-line flags when starting the MCP server to configure permissions at runtime. Flag values override config defaults. This example enables HTTP GETs, allows methods matching 'users\..*' and 'organizations\.retrieve', and blocks methods matching '.*\.delete'.

```bash
npx -y my-org-mcp \
  --allow-http-gets \
  --allowed-methods "users\..*" \
  --allowed-methods "organizations\.retrieve" \
  --blocked-methods ".*\.delete"
```

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

### Offset Pagination Example OpenAPI Specification

Source: https://www.stainless.com/docs/sdks/configure/pagination

Example OpenAPI specification for offset pagination. Defines a GET /accounts endpoint with query parameters my_offset and my_limit, and response properties my_data, my_total, and my_count.

```yaml
openapi: 3.1.0
paths:
  /accounts:
    get:
      parameters:
        - name: my_offset
          in: query
          schema:
            type: integer
        - name: my_limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  my_data:
                    type: array
                    items:
                      type: object
                  my_total:
                    type: integer
                  my_count:
                    type: integer
```

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

### Page Number Pagination Example OpenAPI Specification

Source: https://www.stainless.com/docs/sdks/configure/pagination

Example OpenAPI specification for page number pagination. Defines a GET /accounts endpoint with query parameters page and page_size, and response properties data, last_page, and page.

```yaml
openapi: 3.1.0
paths:
  /accounts:
    get:
      description: Example case for page_number pagination
      parameters:
        - name: page
          in: query
          schema:
            type: integer
        - name: page_size
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MyModel'
                  last_page:
                    type: integer
                    description: The last page number
                  page:
                    type: integer
                    description: The page number
```

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

### Basic CLI usage examples

Source: https://www.stainless.com/docs/cli

Example commands for the generated CLI using the resources defined in the configuration. Note that method names and flags use kebab-case.

```bash
my-tool current-status
# Output: {"status": "Up and running!"}


my-tool people create --job "President" \
    --name.full-name "Abraham Lincoln" \
    --name.nickname "Abe Lincoln"


my-tool people retrieve --id 123


my-tool people list
```

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

### Initialize a project workspace

Source: https://www.stainless.com/docs/quickstart-cli

Initializes a project workspace and guides you through creating or linking a project.

```bash
stl init
```

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

### Equivalent Stainless config entry

Source: https://www.stainless.com/docs/openapi/extensions

This config entry is equivalent to the string shorthand example above, defining the resource and method for the GET /accounts operation.

```yaml
resources:
  accounts:
    methods:
      list: get /accounts

```

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

### Automatic pagination for list_ methods

Source: https://www.stainless.com/docs/sdks/configure/pagination

Methods with names starting with `list_` are automatically paginated if they match a configured pagination scheme. This example shows two such methods.

```yaml
resources:
  accounts:
    methods:
      list_accounts: get /accounts  # Automatically paginated due to list_ prefix
      list_transactions: get /transactions  # Also automatically paginated
```

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

### Go streaming example

Source: https://www.stainless.com/docs/sdks/configure/streaming

Shows how to consume a streaming response in Go using `NewStreaming` and iterating with `stream.Next()`. The example handles each chunk and checks for errors at the end.

```go
stream := client.Chat.Completions.NewStreaming(ctx, acme.ChatCompletionNewParams{
    Model:    acme.String("gpt-4"),
    Messages: []acme.ChatCompletionMessageParam{
        acme.NewUserMessage(acme.NewTextBlock("Hello!")),
    },
})


for stream.Next() {
    event := stream.Current()
    switch delta := event.AsAny().(type) {
    case acme.ChatCompletionChunk:
        if len(delta.Choices) > 0 {
            fmt.Print(delta.Choices[0].Delta.Content)
        }
    }
}


if err := stream.Err(); err != nil {
    log.Fatal(err)
}

```

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

### Fern frontmatter

Source: https://www.stainless.com/docs/migrate/fern-docs

Example of Fern frontmatter with fields like `title`, `description`, `subtitle`, `slug`, `keywords`, and Open Graph metadata. This is the starting point for migration.

```markdown
---
title: How to integrate
description: Learn how to integrate your API documentation
subtitle: Customize content using frontmatter
slug: how-to-integrate
keywords: integration, sdk generation, api, mcp servers, documentation
og:site_name: Your Company Inc.
og:title: SEO Metadata Title
---
```

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

### Run MCP server with local code execution

Source: https://www.stainless.com/docs/mcp

Start the MCP server with local code execution to keep code on your own infrastructure. Requires Deno to be installed on the machine running the server.

```bash
npx -y my-org-mcp --code-execution-mode=local
```

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

### Example folder and file structure

Source: https://www.stainless.com/docs/docs-platform/routing

Shows the expected folder structure for content in src/content/docs. Routes are generated from files and folders in this directory.

```text
📁 <root>
└─ 📁 src/
   ├─ 📁 assets/
   │  ├─ 📄 logo.svg
   │  └─ 📄 banner.png
   └─ 📁 content/
      └─ 📁 docs/
         ├─ 📄 getting-started.md
         └─ 📁 installation/
            ├─ 📄 macos.mdx
            ├─ 📄 windows.mdx
            └─ 📄 linux.mdx
```

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

### Example OpenAPI spec (3.1.0) for Stainless config

Source: https://www.stainless.com/docs/reference/config

Example OpenAPI specification (3.1.0) used to illustrate how Stainless config guesses initial settings. The info section's contact.email and the servers list are read only during initial config generation, not afterwards. The paths define GET and POST endpoints for /accounts with request/response schemas and error responses.

```yaml
# We support 3.X formats. Read about the difference between 3.0 and 3.1
# at https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
openapi: 3.1.0


# Information in this section is used in the initial guess of the Stainless config, but not read afterwards.
# For example, contact.email is used in the initial guess of the Stainless config for determining
# `organization.contact`, which is linked to in each of the SDKs' README.md.
info:
  title: Acme Developer API
  description: >
    The Acme Developer API is designed to provide a predictable programmatic
    interface for accessing your Acme account through an API and transaction
    webhooks.
  version: 1.0.0
  termsOfService: "https://acme.com/legal#terms"
  contact:
    email: support@acme.com


# The servers here is used in the initial guess of the Stainless config for determining `environments` which
# allows users to change between various base URLs easily.
servers:
  - url: https://api.acme.com/v1
    description: Acme production API server
  - url: https://sandbox.acme.com/v1
    description: Sandbox environment that provides key functionality mirroring production


# Tags are not used by Stainless, but are recommended for other OpenAPI tools and book-keeping.
tags:
  - name: Account
  - name: Friends
  - name: Status


# Paths define the endpoints and methods, their request/response types, and more.
paths:
  /accounts:
    get:
      tags:
        - Account
      summary: List account
      description: List account
      parameters:
        - $ref: "#/components/parameters/Cursor"
        - $ref: "#/components/parameters/Limit"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/PaginationResponse"
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/Account"
    post:
      tags:
        - Account
      summary: Create account
      description: Create account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Account"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Account"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        "429":
          $ref: "#/components/responses/TooManyRequests"
```

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

### Default two-tab configuration in astro.config.ts

Source: https://www.stainless.com/docs/docs-platform/navigation

Shows the default `tabs` configuration with two tabs: 'Guides' and 'API Reference'. The 'API Reference' tab uses `generateAPIReferenceItems()` to populate its sidebar. This is the starting point for customizing your site's navigation.

```javascript
import { defineConfig } from "astro/config";
import {
  generateAPIReferenceItems,
  stainlessDocs,
} from "@stainless-api/docs";


export default defineConfig({
  integrations: [
    stainlessDocs({
      // ...
      tabs: [
        {
          label: "Guides",
          link: "/",
          sidebar: [
            {
              label: "Getting started",
              items: [""], // "" links to the index page
            },
            {
              label: "Guides",
              autogenerate: { directory: "guides" },
            },
          ],
        },
        {
          label: "API Reference",
          link: "/api",
          sidebar: [
            {
              label: "API Reference",
              items: generateAPIReferenceItems(),
            },
          ],
        },
      ],
    }),
  ],
});
```

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

### Stainless config: code_exec_permissions block

Source: https://www.stainless.com/docs/mcp/permissions

Add a code_exec_permissions block to the mcp_server options in your Stainless config file to set permissions. This example enables HTTP GET methods, allows methods matching 'users\..*' and 'organizations\.retrieve', and blocks methods matching '.*\.delete'.

```yaml
targets:
  typescript:
    options:
      mcp_server:
        code_exec_permissions:
          allow_http_gets: true
          allowed_methods:
            - "users\\..*"
            - "organizations\\.retrieve"
          blocked_methods:
            - ".*\\.delete"
```

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

### Example main.tf for testing a generated provider

Source: https://www.stainless.com/docs/terraform

A sample main.tf file that configures the required provider and defines a resource instance. It includes the terraform block with required_providers, the provider configuration with an API key, and a resource block copied from the examples directory.

```hcl
terraform {
  required_providers {
    <your-org> = {
      source  = "<your-org>/<providername>"
      version = "~> 1.0.0"
    }
  }
}


provider "<providername>" {
  api_key = "<dev api key>"
}


# copied from examples/resources
resource "<providername>_<resourcename>" "example" {
  name = "The Cube"
  description = "A large stainless steel cube"
  image_url = "https://images.squarespace-cdn.com/content/v1/5488f21fe4b055c9cb360909/1427135193771-IM8B5KC0OUVQCRG7YCQD/2013-10+Steel+Cubes+-2.jpg?format=750w"
  price = 1000
}
```

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

### Start server with API key environment variable

Source: https://www.stainless.com/docs/mcp/remote

Sets the API key as an environment variable and starts the server. Used for public APIs that require authentication but want to expose some functionality publicly.

```bash
export MY_API_KEY=your-api-key
npx -y my-org-mcp --transport=http
```

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

### Define client-level methods using $client resource

Source: https://www.stainless.com/docs/sdks/configure

Shows how to place methods directly on the client by using the special resource '$client'. The resulting SDK usage is also shown.

```yaml
resources:
  $client:
    methods:
      health: get /health
```

```python
health = client.health()
```

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

### CREATE EXTENSION my_api

Source: https://www.stainless.com/docs/sdks/sql

Users pass the extension name to `CREATE EXTENSION` to install the extension.

```sql
CREATE EXTENSION my_api;

```

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

### Transform JSON responses with --transform and GJSON queries

Source: https://www.stainless.com/docs/cli

Use the --transform flag with GJSON query syntax to filter or reshape JSON responses. The examples show extracting a single field, getting the first array element, extracting multiple fields into an object, and filtering array items by condition. Use --transform-error to apply the same transformation to error responses.

```bash
# Extract just the name field
my-tool people retrieve --id 123 --transform "name"
```

```bash
# Get the first item from an array
my-tool people list --transform "items.0"
```

```bash
# Extract multiple fields
my-tool people retrieve --id 123 --transform "{name,job}"
```

```bash
# Filter array items
my-tool people list --transform 'items.#(job=="President")#'
```

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

### Multiple API Keys - Go SDK Initialization

Source: https://www.stainless.com/docs/sdks/configure/client

Initializes the Go SDK with both read and write keys using option functions. Both keys are sent with every request, as shown in the example calls.

```go
client := myapi.NewClient(
    option.WithReadKey("read_key_123"),
    option.WithWriteKey("write_key_456"),
)


// Both keys are sent with requests
client.Resources.List(ctx)
client.Resources.New(ctx, ...)
```
Tokens:
Raw