Skip to main content
Glama

faf_score

Read-only

Score a project's AI-readability with a deterministic 0–100% result, including tier and per-slot breakdown, for quick status checks.

Instructions

Score a project.faf and return its 0–100% AI-readability, tier, and per-slot breakdown, via the deterministic Mk4 engine. Use this for a quick status check; use faf_doctor when you need to diagnose and fix what's missing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoProject path. Sets session context for subsequent calls.
detailsNoInclude detailed breakdown and improvement suggestions

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoPath that was scored
tierYesTier name for this score (e.g. Bronze, Trophy)
emptyNoActive slots still empty
scoreYesAI-readiness score, 0-100
totalNoTotal slots
activeNoSlots active for this app_type
hasFafYesWhether a readable, valid project.faf was scored
parityNoDeterminism parity receipt — an engine-agnostic hash any conformant scorer reproduces for this exact file. Third-party verifiable: sha256(projection) === parityHash.
ignoredNoSlots marked slotignored (inactive for this app_type)
nextTierNoNext tier above the current score, or null at top tier
inheritedNoTrue if the score is attested from a source repo (app_type: about)
populatedNoActive slots that are filled
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the tool's safety is clear. The description adds that it uses a 'deterministic Mk4 engine', which is extra context beyond the 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?

Two sentences: first defines purpose and output, second provides usage guidance. No wasted words, front-loaded with key information.

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, output (with tier and breakdown), usage guidance, and engine detail. Output schema exists, so return values are explained there. Complete for a simple scoring tool.

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% (both parameters have descriptions). The description does not add any extra meaning beyond what the schema provides, so baseline 3 is appropriate.

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 scores a 'project.faf' and returns '0–100% AI-readability, tier, and per-slot breakdown' using a specific verb 'Score' and resource. It distinguishes from sibling 'faf_doctor' by noting it's for quick checks vs. diagnosis.

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?

Explicitly tells when to use this tool ('quick status check') and when to use an alternative ('use faf_doctor when you need to diagnose and fix'). This provides clear decision guidance.

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

Install Server

Other Tools

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/Wolfe-Jam/claude-faf-mcp'

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