Skip to main content
Glama

get_health_score

Idempotent

Assess overall GitHub repository health by calculating a 0-100 score and A-F grade across CI, security, community, maintenance, and freshness. Includes improvement suggestions and historical trend data.

Instructions

Calculates a 0-100 health score and A-F grade for a GitHub repository.

  • Side effects: Writes a trend snapshot to local disk for history tracking. Read-only against GitHub API.

  • Data sources: GitHub REST API (repos, actions, dependabot) and OpenSSF Scorecard API.

  • Auth requirements: No authentication required for public repositories. Uses configured token if available.

  • Rate limits: Subject to standard GitHub API limits (heavy usage across multiple endpoints).

  • Return shape: Returns a JSON object with a grade (A-F), total score, detailed category breakdown (CI, freshness, security, community, maintenance), improvement suggestions, and historical trend data.

  • Usage guidelines: Use this tool ONLY for deep analytical grading and overall repository health assessment. DO NOT use this tool for quick metadata checks:

    • For basic raw metadata (stars, language, etc.), use 'get_repo_health' instead.

    • For raw CI workflow statuses, use 'check_ci_status' instead.

    • For deep code vulnerability scanning, use 'analyze_code_scanning' instead.

    • For DORA metrics, use 'get_dora_metrics' instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoYesGitHub repository name (e.g., 'sdk')
ownerYesGitHub repository owner (e.g., 'modelcontextprotocol')

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
trendYes
reportYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changedv1.1.7
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "report": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "breakdown": {
      +          "additionalProperties": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "detail": {
      +                "type": "string"
      +              },
      +              "score": {
      +                "type": "number"
      +              },
      +              "weight": {
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "score",
      +              "weight",
      +              "detail"
      +            ],
      +            "type": "object"
      +          },
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        },
      +        "checkedAt": {
      +          "type": "string"
      +        },
      +        "grade": {
      +          "type": "string"
      +        },
      +        "gradeMeaning": {
      +          "type": "string"
      +        },
      +        "repo": {
      +          "type": "string"
      +        },
      +        "score": {
      +          "type": "number"
      +        },
      +        "suggestions": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "repo",
      +        "score",
      +        "grade",
      +        "breakdown",
      +        "suggestions",
      +        "checkedAt",
      +        "gradeMeaning"
      +      ],
      +      "type": "object"
      +    },
      +    "trend": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": false,
      +          "properties": {
      +            "direction": {
      +              "type": "string"
      +            },
      +            "previousCheckedAt": {
      +              "type": "string"
      +            },
      +            "previousGrade": {
      +              "type": "string"
      +            },
      +            "previousScore": {
      +              "type": "number"
      +            },
      +            "scoreDiff": {
      +              "type": "number"
      +            }
      +          },
      +          "required": [
      +            "previousScore",
      +            "previousGrade",
      +            "previousCheckedAt",
      +            "scoreDiff",
      +            "direction"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    }
      +  },
      +  "required": [
      +    "report",
      +    "trend"
      +  ],
      +  "type": "object"
      +}
  2. Changed2 schema fields changedv1.1.4
    • changedInput schema / properties / owner / description
      Previous value: -"GitHub repository owner"New value: +"GitHub repository owner (e.g., 'modelcontextprotocol')"
    • changedInput schema / properties / repo / description
      Previous value: -"GitHub repository name"New value: +"GitHub repository name (e.g., 'sdk')"
  3. First observedv1.1.3

TDQS

A4.7/5.0
Behavior5/5

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

The description discloses side effects ('Writes a trend snapshot to local disk'), data sources (GitHub REST API and OpenSSF Scorecard API), auth requirements, and rate limits. It also details the exact return shape with category breakdown, suggestions, and historical trend data. This goes well beyond the sparse boolean annotations.

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?

The description is organized into labeled bullet sections (Side effects, Data sources, Auth requirements, Rate limits, Return shape, Usage guidelines) with the core purpose front-loaded. Every section conveys non-redundant, decision-relevant information, so the length is justified.

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?

The description covers purpose, alternatives, side effects, data sources, auth, rate limits, and return shape, leaving no operational gaps. The presence of an output schema further reduces the need to explain return values, yet the description still provides a helpful summary.

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?

Both parameters repo and owner are fully described in the input schema with examples, yielding 100% schema description coverage. The description adds context about public vs. protected repositories but no additional parameter-level detail, so the baseline 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?

The opener 'Calculates a 0-100 health score and A-F grade for a GitHub repository' names a specific verb, resource, and output. The later guidance 'Use this tool ONLY for deep analytical grading and overall repository health assessment' explicitly differentiates it from siblings like get_repo_health and check_ci_status. Unambiguous and distinctive.

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?

The description provides explicit when-to-use guidance: 'Use this tool ONLY for deep analytical grading... DO NOT use this tool for quick metadata checks.' It then lists four sibling alternatives with precise conditions, e.g., 'For basic raw metadata (stars, language, etc.), use get_repo_health instead.' No inference is needed.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/alexbypa/github-projectpulse-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server