Skip to main content
Glama
hackIDLE

FedRAMP Docs MCP Server

by hackIDLE

search_definitions

Search FedRAMP definitions by term to find official definitions and alternate terms from FRD documents for compliance and security analysis.

Instructions

Search FedRAMP definitions (FRD document) by term. Returns matching definitions with their full text and any alternate terms.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
termYesSearch term to find in definitions
limitNo

Implementation Reference

  • The execute handler implementing the core logic: retrieves FRD document, filters definitions matching the term in term, definition, or alts, and returns paginated results.
    execute: async (input) => {
      const frdDoc = getFrmrDocuments().find((doc) => doc.type === "FRD");
      if (!frdDoc || !frdDoc.raw) {
        return { total: 0, definitions: [] };
      }
    
      const raw = frdDoc.raw as Record<string, unknown>;
      const frd = raw.FRD as Record<string, unknown> | undefined;
      const allDefs = (frd?.ALL as Definition[]) ?? [];
    
      const searchLower = input.term.toLowerCase();
      const matches = allDefs.filter((def) => {
        if (def.term?.toLowerCase().includes(searchLower)) return true;
        if (def.definition?.toLowerCase().includes(searchLower)) return true;
        if (def.alts?.some((alt) => alt.toLowerCase().includes(searchLower)))
          return true;
        return false;
      });
    
      return {
        total: matches.length,
        definitions: matches.slice(0, input.limit),
      };
    },
  • Input schema using Zod: requires 'term' string, optional 'limit' number (1-100, default 20).
    const schema = z.object({
      term: z.string().describe("Search term to find in definitions"),
      limit: z.number().int().min(1).max(100).default(20),
    });
  • Registers the searchDefinitionsTool by including it in the array passed to registerToolDefs in registerTools function.
    searchDefinitionsTool,
  • TypeScript interface defining the structure of a definition object used in filtering and output.
    interface Definition {
      id: string;
      term: string;
      definition: string;
      alts?: string[];
      note?: string;
    }
  • Complete ToolDefinition export including name, description, schema, and execute handler.
    export const searchDefinitionsTool: ToolDefinition<
      typeof schema,
      { total: number; definitions: Definition[] }
    > = {
      name: "search_definitions",
      description:
        "Search FedRAMP definitions (FRD document) by term. Returns matching definitions with their full text and any alternate terms.",
      schema,
      execute: async (input) => {
        const frdDoc = getFrmrDocuments().find((doc) => doc.type === "FRD");
        if (!frdDoc || !frdDoc.raw) {
          return { total: 0, definitions: [] };
        }
    
        const raw = frdDoc.raw as Record<string, unknown>;
        const frd = raw.FRD as Record<string, unknown> | undefined;
        const allDefs = (frd?.ALL as Definition[]) ?? [];
    
        const searchLower = input.term.toLowerCase();
        const matches = allDefs.filter((def) => {
          if (def.term?.toLowerCase().includes(searchLower)) return true;
          if (def.definition?.toLowerCase().includes(searchLower)) return true;
          if (def.alts?.some((alt) => alt.toLowerCase().includes(searchLower)))
            return true;
          return false;
        });
    
        return {
          total: matches.length,
          definitions: matches.slice(0, input.limit),
        };
      },
    };
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the return format ('matching definitions with their full text and any alternate terms'), which is helpful, but lacks details on permissions, rate limits, error handling, or pagination. For a search tool with zero annotation coverage, this is insufficient.

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, well-structured sentence that efficiently conveys the tool's purpose and output. It's front-loaded with the core functionality and avoids unnecessary details, making it highly concise and easy to parse.

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 the tool's moderate complexity (2 parameters, no output schema, no annotations), the description is minimally adequate. It covers the basic purpose and return format but lacks details on usage context, parameter behavior, and operational constraints. Without annotations or output schema, more completeness is needed for a higher score.

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 50% (only the 'term' parameter has a description). The description adds no additional parameter semantics beyond what's in the schema—it doesn't explain search behavior (e.g., exact match, partial match, case sensitivity) or the 'limit' parameter's effect. With moderate schema coverage, the baseline is 3, as the description doesn't compensate for gaps.

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 tool's purpose: 'Search FedRAMP definitions (FRD document) by term.' It specifies the verb ('search'), resource ('FedRAMP definitions'), and scope ('FRD document'). However, it doesn't explicitly differentiate from sibling tools like 'search_markdown' or 'grep_controls_in_markdown', which limits it to a 4 rather than a 5.

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. It doesn't mention sibling tools like 'search_markdown' or 'grep_controls_in_markdown', nor does it specify prerequisites, exclusions, or contextual usage. This lack of comparative guidance results in a low score.

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/hackIDLE/fedramp-docs-mcp'

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