list_frmr_documents
Discover available FedRAMP FRMR documents including security indicators, assessment standards, vulnerability data, change notifications, definitions, and authorization data to begin compliance analysis.
Instructions
List available FRMR JSON documents and metadata. This is usually the first tool to call to discover what FedRAMP data is available. Returns KSI (Key Security Indicators), MAS (Minimum Assessment Standard), VDR (Vulnerability Detection), SCN (Significant Change Notifications), FRD (Definitions), and ADS (Authorization Data Sharing) documents.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/list_frmr_documents.ts:15-18 (handler)The tool execution handler: an async function that calls the helper listFrmrDocuments() and returns the list of FRMR document metadata wrapped in an object.
execute: async () => { const documents = listFrmrDocuments(); return { documents }; }, - src/tools/list_frmr_documents.ts:6-6 (schema)Input schema using Zod: an empty object schema indicating the tool takes no input parameters.
const schema = z.object({}); - src/tools/register.ts:27-27 (registration)Registration of the tool by including listFrmrDocumentsTool in the array passed to registerToolDefs in the registerTools function.
listFrmrDocumentsTool, - src/frmr.ts:16-20 (helper)Core helper function listFrmrDocuments() that fetches all FRMR documents from the indexer and extracts their metadata.
export function listFrmrDocuments(): FrmrDocumentMeta[] { return getFrmrDocuments().map( ({ raw, rawText, topLevelKeys, idKey, ...meta }) => meta, ); } - src/tools/register.ts:16-16 (registration)Import statement for the listFrmrDocumentsTool required for registration.
import { listFrmrDocumentsTool } from "./list_frmr_documents.js";