Files
hive/docs/templates/tool-readme-template.md
T

1.3 KiB

{Tool Name} Tool

{Brief description of what the tool does and its primary use case.}

Setup

# Required
export {ENV_VAR}=your-api-key

Get your key:

  1. Go to {help_url}
  2. {Step to create/generate a key}
  3. {Step to copy the key}
  4. Set {ENV_VAR} environment variable

Alternatively, configure via the credential store (CredentialStoreAdapter).

Tools ({count})

Tool Description
{tool_function_name} {What it does}
{tool_function_name} {What it does}

Usage

{Action name}

result = {tool_function_name}(
    param="value",
)
# Returns: {brief description of return value}

{Action name}

result = {tool_function_name}(
    param="value",
)
# Returns: {brief description of return value}

Scope

  • {Capability 1}
  • {Capability 2}
  • {Capability 3}

Rate Limits

Tier Limit
Free {X requests/minute}
Paid {Y requests/minute}

API Reference