Skip to main content
Glama

Set project token

set-project-token

Store a Goby API key for a project directory to authorize all Goby tool runs from that directory immediately, keeping the key in user config instead of the repository.

Instructions

Store a Goby API key for a project directory so every Goby tool run from that directory (or any subdirectory) uses it. Takes effect immediately, no restart. Tokens are written to the user's config file, never into the repo.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dirNoAbsolute project directory. Defaults to the directory this server was started in (the Claude Code project). Pass it explicitly when unsure.
api_keyYesGoby API key, gk_<publicId>_<secret>, minted under Admin → API keys
base_urlNoYour Goby instance origin, e.g. https://acme.goby.chat. Required unless a default URL is stored (goby-mcp token set-default --base-url ...) or GOBY_BASE_URL is set.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It discloses key side effects: tokens are written to the user's config file (not the repo), take effect immediately without restart, and apply to all subdirectories. It does not mention overwrite behavior or error conditions, but the stated persistence and scope are valuable beyond a bare 'set token' statement.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with zero filler. The core purpose and side effects are front-loaded, and every clause earns its place. It is concise without omitting essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with three parameters and no output schema, the description covers the main behavioral aspects (persistence, scope, immediacy) and the schema covers parameter details. It does not explain the response format or failure modes, but these are not critical for the agent to call the tool correctly. Overall, it is sufficiently complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%—every parameter (dir, api_key, base_url) has a description in the input schema. The tool description adds no new parameter-specific details; it only refers to 'project directory' which the schema already explains. Per the rubric, baseline 3 is appropriate when the schema handles parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Store a Goby API key') and the resource ('for a project directory'), and explains the effect on subsequent tool runs. It distinguishes itself from sibling tools list-project-tokens and remove-project-token by focusing on the set operation, leaving no ambiguity about what it does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context that this sets a project-scoped token for all Goby tool runs, but it does not explicitly mention when not to use it or name alternatives like list-project-tokens/remove-project-token. The 'when' is implied by the purpose but not stated as a comparison, so it falls short of the explicit guidance level.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.