Skip to main content
Glama

guard_login

Starts HOC Guard authentication by returning a link and code for browser approval, so scans and generators can run with the authorized login.

Instructions

Começa o login no HOC Guard, no estilo npm login/gh auth login. Devolve na hora um link e um código curto: mostre ao usuário, peça pra abrir o link e autorizar no navegador. Depois que ele autorizar, chame guard_login_check para concluir. Rode uma vez por máquina; depois guard_scan_site, os geradores e as ferramentas de finalidades usam o login sozinhos.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scopeNoPermissões pedidas. Padrão: "scan generate gcc:purposes:read gcc:purposes:write" (varrer, gerar e consultar/editar finalidades; o token só recebe o que o papel da conta permite).scan generate gcc:purposes:read gcc:purposes:write

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare openWorldHint=true and idempotentHint=false, so the bar is lower. The description adds real substance beyond that: the call returns a link and short code immediately without blocking, completion is deferred to a second tool, and the resulting token is scoped by account role. It does not say where the token is stored or whether it expires, which keeps this from a 5.

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?

Three sentences, each load-bearing: what the tool does and its style, what it returns and what the user must do, and the follow-up call plus run-once-per-machine rule. The critical immediate-return behavior is front-loaded.

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

Completeness5/5

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

There is no output schema, so the description must carry return-value semantics, and it does — an immediate link plus short code, with the authorization step delegated to guard_login_check. Combined with the sibling hand-off and reuse note, an agent has everything needed to drive the flow correctly.

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 description coverage is 100% with a single optional 'scope' parameter whose default and meaning are fully documented in the schema. The description adds no additional syntax or format guidance for scope, so the baseline of 3 applies.

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?

States a specific verb and resource in plain terms ('Começa o login no HOC Guard') and immediately anchors it to familiar analogues (npm login / gh auth login). It is clearly distinguishable from siblings guard_login_check (step 2) and guard_logout, which the description names or implies.

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

Usage Guidelines5/5

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

Explicit sequencing: run this first, show the user the link/code, wait for browser authorization, then call guard_login_check to complete. It also states the frequency constraint ('uma vez por máquina') and that downstream tools (guard_scan_site, generators, purposes) reuse the session automatically, so the agent knows when NOT to call it again.

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