Skip to main content
Glama

faf_what

Explains the .faf file format, covering its definition, structure, and typical use cases.

Instructions

Quick explanation of .faf format

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handleFafWhat method - returns a hardcoded text string explaining what .faf format is (Foundational AI-context Format). No arguments needed. Returns a CallToolResult with the explanation text.
      private async handleFafWhat(_args: any): Promise<CallToolResult> {  // ✅ FIXED: Prefixed unused args
        const whatText = `.faf = project DNA for AI
    
    WHAT: .faf = Foundational AI-context Format
          (The dot means it's a file format, like .jpg or .pdf)
    
    WHY:  Persistent project context that works across
          Claude, Gemini, Grok, Cursor, and any AI tool.
    
    HOW:  Run 'faf' on any project to create one.
          Run 'faf_score' to check AI-readiness (target: 99%).
    
    REMEMBER: Always use ".faf" with the dot - it's a FORMAT!
    
    🧡⚡️ Persistent context. Zero drift.`;
    
        return {
          content: [{
            type: 'text',
            text: whatText
          }]
        };
      }
  • Tool registration in listTools(): defines the 'faf_what' tool with description 'Quick explanation of .faf format' and an empty inputSchema (no parameters).
      name: 'faf_what',
      description: 'Quick explanation of .faf format',
      inputSchema: {
        type: 'object',
        properties: {},
      }
    },
  • The switch case in callTool() that routes 'faf_what' to the handleFafWhat handler.
    case 'faf_what':
      return await this.handleFafWhat(args);
  • Tool visibility metadata: faf_what is categorized as 'advanced' visibility, 'help' category, with description 'What is .faf? Quick explanation'.
    faf_what: {
      name: 'faf_what',
      visibility: 'advanced',
      category: 'help',
      description: 'What is .faf? Quick explanation',
    },
  • faf_what listed in the advanced/utility tools array in the visibility type system.
      'faf_what',
      'faf_friday',
      'faf_debug',
    ] as const;
Behavior2/5

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

No annotations provided, so the description carries full burden. It only states 'quick explanation' with no details about return format, side effects, or any behavioral traits beyond being read-only.

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 extremely concise (one phrase) and front-loaded. It could include more detail without losing conciseness, but it is not verbose.

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

Completeness3/5

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

Given no parameters, no annotations, and no output schema, the description is minimal. It explains the basic purpose but lacks details about the output format or usage context, making it adequate but not thorough.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has zero parameters and 100% coverage. Description adds no parameter information, but baseline for 0 params is 4. The description suffices by indicating the tool's purpose.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'explanation' and the resource '.faf format', making the purpose clear. However, it does not differentiate from sibling tools like 'faf_about' or 'faf_guide', which could have similar purposes.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. No context, exclusions, or examples are given.

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/grok-faf-mcp'

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