Files
genai-toolbox/packages/server/README.md
2026-01-09 14:32:43 +05:30

1.7 KiB

Toolbox

A CLI tool for running a toolbox server.

Installation

You can install the toolbox globally:

npm install -g @toolbox-sdk/server

Or run it directly using npx:

npx @toolbox-sdk/server

Configuration

The toolbox requires a tools.yaml file in the current working directory to define sources, tools, and prompts.

Example tools.yaml

sources:
  my-pg-source:
    kind: postgres
    host: 127.0.0.1
    port: 5432
    database: toolbox_db
    user: postgres
    password: password
tools:
  search-hotels-by-name:
    kind: postgres-sql
    source: my-pg-source
    description: Search for hotels based on name.
    parameters:
      - name: name
        type: string
        description: The name of the hotel.
    statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';
prompts:
  code-review:
    description: "Asks the LLM to analyze code quality and suggest improvements."
    messages:
      - role: "user"
        content: "Please review the following code for quality, correctness, and potential improvements: \n\n{{.code}}"
    arguments:
      - name: "code"
        description: "The code to review"
        required: true

To learn more on how to configure your toolbox, visit the official docsite.

Platform Support

The toolbox automatically handles platform-specific binaries. Supported platforms include:

  • macOS (arm64, x64)
  • Linux (x64)
  • Windows (x64)

Resources

For more information, visit the