Skip to main content
Glama

faf_score

Read-only

Assess your project's AI-readability using F1-inspired metrics from the project.faf file. Optionally receive a detailed breakdown and improvement suggestions.

Instructions

Calculate your project's AI-readability from project.faf (project DNA for AI) - F1-inspired metrics!

Input Schema

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

Output Schema

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

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

Annotations declare readOnlyHint: true and destructiveHint: false, which the description does not contradict. The description adds the detail 'F1-inspired metrics' but does not elaborate on behavioral traits beyond what annotations already convey.

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 a single sentence that efficiently conveys the core purpose. It front-loads the key action and resource, with no unnecessary words or redundancy.

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?

Given that the input schema fully describes parameters and an output schema exists, the description provides sufficient high-level context. It mentions the metric style (F1-inspired) which adds useful flavor. The tool is simple and the description covers what an agent needs to understand its role.

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 tool description adds no additional parameter semantics beyond the schema, so it meets the baseline without providing extra meaning.

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 verb 'calculate', the resource 'project's AI-readability', and the source 'project.faf'. It distinguishes from sibling faf tools by specifying a unique function (scoring/readability). The title annotation reinforces this purpose.

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

Usage Guidelines3/5

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

The description provides no explicit guidance on when to use this tool versus siblings. It only describes what it does, leaving the agent to infer usage context from the tool name and sibling list.

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