Skip to main content
Glama

Get api token

archivebox_get_api_token

Generates an ArchiveBox API token using username and password credentials to enable authenticated API access.

Instructions

Generate an API token for a given username & password

Args: username: The username for authentication. password: The password for authentication.

Returns: Response: The response object from the POST request.

Raises: ParameterError: If the provided parameters are invalid.

Input Schema

NameRequiredDescriptionDefault
passwordNo
usernameNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.5.1

TDQS

B3/5.0
Behavior3/5

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

Annotations already disclose the key traits (readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=false). The description adds that it performs a POST and raises ParameterError for invalid params, which is useful, but it omits whether generating a token invalidates prior tokens, how credentials are obtained, or any rate/expiry behavior.

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

Conciseness3/5

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

The purpose is front-loaded in the first sentence, which is good, but the Args/Returns/Raises boilerplate is padded and the Returns line ('response object from the POST request') conveys little given there is no output schema to lean on.

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?

Bar is lower here: annotations carry the safety profile, and with only two simple credential parameters there is limited surface to cover. The gaps - no alternative-tool routing and no clarity on token lifecycle or invalid-credential behavior beyond ParameterError - are real but modest for this tool's complexity.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry the load, and it barely does: 'username: The username for authentication' and 'password: ... for authentication' are near-tautological. It identifies both as auth credentials but adds no format, sourcing, or nullability meaning.

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

Purpose4/5

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

States a specific verb (Generate an API token) and resource (token for a username & password), so an agent understands what it produces. It does not, however, distinguish itself from the close sibling archivebox_check_api_token, nor does it reconcile the 'get' name with the 'generate' behavior.

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

Usage Guidelines2/5

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

There is no when-to-use guidance and no mention of when not to use it. The very relevant alternative archivebox_check_api_token exists in the sibling set but is never referenced, leaving the agent to guess which token tool applies.

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