generate-security-md

Generate a SECURITY.md file by analyzing repository code, dependencies, and threat surfaces.

7|4|Updated Oct 24, 2024
One-click install
npx skills add https://github.com/Mellanox/netop-tools --skill generate-security-md-mellanox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-security-md
Source: https://github.com/Mellanox/netop-tools
Command: npx skills add https://github.com/Mellanox/netop-tools --skill generate-security-md-mellanox

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing a compliant, project-specific SECURITY.md requires manual codebase analysis and knowledge of NVIDIA security documentation standards, which is time-consuming and often produces generic boilerplate. ## Core Features & Use Cases - Automated Codebase Reconnaissance: Scans languages, dependencies, APIs, auth patterns, and data handling to build a project-specific threat model. - Four Required Sections: Generates Reporting Policy, Architecture Context, Threat Model, and Critical Security Assumptions following NVIDIA standards. - Triage Persistence: Stores false-positive and accepted-risk decisions in .security-triage.yaml so re-runs only surface new findings. - Use Case: A maintainer preparing a repository for publication runs the skill to produce a complete SECURITY.md with repository and service exposure classifications, optionally incorporating an existing TAVA document. ## Quick Start Ask the agent to generate a SECURITY.md for this repository, optionally providing a path to an existing TAVA or threat-model document.

Frequently Asked Questions about generate-security-md

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a SECURITY.md file for my repository?

Run the skill from within a git repository and it analyzes languages, dependencies, APIs, and auth patterns to produce a SECURITY.md with Reporting Policy, Architecture Context, Threat Model, and Critical Security Assumptions sections.

What sections does a generated SECURITY.md contain?

The generated file contains four required sections: Reporting a Vulnerability, Security Architecture & Context, Threat Model, and Critical Security Assumptions. Optional sections like Scope, Dependency Security, and Accepted Risks are added when the codebase warrants them.

Can I incorporate an existing TAVA or threat model document?

Yes, pass a TAVA document path as an argument and the skill extracts threats, severity ratings, trust boundaries, and mitigations from it. Supported formats include markdown, text, PDF, HTML, and CSV.

Does the skill work on repositories that already have a SECURITY.md?

Yes, it performs a gap analysis showing which required sections are present, missing, or incomplete. You can then choose to replace the file entirely, update only incomplete sections, or review a diff first.

How does the skill avoid re-reporting triaged findings?

Triage decisions are persisted in a .security-triage.yaml file at the repo root. On subsequent runs, findings matching false-positive slugs are suppressed and accepted risks move to a dedicated subsection.

What are the limitations of automated threat model generation?

The threat model is derived from static codebase reconnaissance, so it reflects only patterns detectable in source files. It assumes the operator confirms exposure classifications and reviews generated content before committing.