Skip to main content
Glama

sassy_setup_github

Idempotent

Set up GitHub authentication for SassyMCP by checking, saving, or skipping a token. Validates tokens against the GitHub API and opens the token creation page when needed.

Instructions

Mutating when saving; read-only for check and open_browser. The action parameter (default "check") selects the step. action=check validates the GITHUB_TOKEN or GITHUB_PERSONAL_ACCESS_TOKEN environment variable against the GitHub API and reports the login and scopes, or that no token exists. action=open_browser opens the GitHub token creation page locally and returns instructions with the recommended scopes (Contents, Issues, Pull Requests, Metadata). action=save_token validates the supplied token parameter (must start with ghp_ or github_pat_) against api.github.com/user; on success it stores the token in the process environment and records github_configured plus the GitHub username in config. The token lasts only for this session unless also set in system env or MCP client config. action=skip records the skip. Use this to enable the sassy_github_* tools.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tokenNo
actionNocheck

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.15.1
    • addedOutput schema / additionalProperties
      Added value: +true
    • removedOutput schema / properties
      Removed value: -{
      -  "result": {
      -    "title": "Result",
      -    "type": "string"
      -  }
      -}
    • removedOutput schema / required
      Removed value: -[
      -  "result"
      -]
    • changedOutput schema / title
      Previous value: -"sassy_setup_githubOutput"New value: +"sassy_setup_githubDictOutput"
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior5/5

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

The annotations indicate idempotentHint=true, which is consistent with the description's note that save_token stores a token. The description adds critical behavioral context: it explicitly warns that save_token is 'Mutating when saving; read-only for check and open_browser' and that 'The token lasts only for this session unless also set in system env or MCP client config.' It also explains what happens on success (stores in process env, records config) and the validation steps. This goes beyond annotations, which only indicate readOnlyHint=false, openWorldHint=true, idempotentHint=true, destructiveHint=false. No contradiction with annotations.

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

Conciseness4/5

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

The description is moderately long but each sentence provides necessary information about the actions and session behavior. The overall purpose is front-loaded ('Mutating when saving; read-only for check and open_browser'), and the actions are explained in logical order. It could be slightly more concise, but every part earns its place.

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?

Given that the tool has an output schema (not detailed here), the description doesn't need to explain return values. The tool is moderately complex with multiple actions and side effects (validating API, storing token, config changes). The description covers the key aspects: action behavior, token validation requirements, session persistence, and configuration updates. It could detail error scenarios or alternative setup methods, but for an agent to call it correctly, it's adequately 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?

The schema provides no descriptions for the two parameters (coverage 0%), so the description must compensate. It does explain 'action' parameter in detail: default 'check', and each action's behavior. It also explains the 'token' parameter's requirements (must start with ghp_ or github_pat_) and its role in save_token. This adds meaning beyond the schema's minimal property definitions, so a score of 3 is appropriate given that the schema coverage is zero and the description does provide some parameter guidance.

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 tool's purpose: it configures GitHub authentication for enabling sassy_github_* tools. It identifies the three actions (check, open_browser, save_token, skip) and what each does, distinguishing it from sibling setup tools like sassy_setup_ssh and sassy_setup_license. The specific verb (setup) and resource (GitHub) are explicit.

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

Usage Guidelines4/5

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

The description explicitly states when to use this tool: 'Use this to enable the sassy_github_* tools.' It also explains the action parameter, which guides selection among the tool's own modes. However, it doesn't explicitly mention when NOT to use it or mention alternatives (e.g., sassy_setup_generate_token might be an alternative for token generation), but the 'use this to enable' phrasing is clear enough.

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

Deploy Server

Other Tools