Skip to content

docs(secops): add Agentic Detection Engineering guide and tool documentation - #306

Merged
dandye merged 5 commits into
add_de_agent_apisfrom
docs/de-agent
Sep 4, 2026
Merged

docs(secops): add Agentic Detection Engineering guide and tool documentation#306
dandye merged 5 commits into
add_de_agent_apisfrom
docs/de-agent

Conversation

@dandye

@dandye dandye commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fast follow to #305: adds dedicated documentation, user guide, and Sphinx documentation updates for Google SecOps Agentic Detection Engineering (ADE).

This includes:

  • A comprehensive end-to-end guide on Agentic Detection Engineering in Google SecOps.
  • Visual instructions with screenshot for enabling Synthetic Data Visibility in the SecOps Web UI.
  • Detailed reference and walkthrough examples for the 5 newly added ADE FastMCP tools.
  • Skill registration and table-of-contents / navigation links.

Changes

1. Dedicated ADE Guide (docs/agentic_detection_engineering.md)

  • Explains the end-to-end detection lifecycle: Threat Intel Ingestion $\rightarrow$ TDO Generation $\rightarrow$ Synthetic Simulation $\rightarrow$ Sandboxed Rule Coverage Evaluation (LRO) $\rightarrow$ Gap Analysis $\rightarrow$ Candidate YARA-L 2.0 Rule Generation $\rightarrow$ Verification & Deployment.
  • Includes step-by-step instructions on enabling Synthetic Data Visibility in the Google SecOps UI (Settings > User Preferences > Synthetic Data Visibility > Show synthetic test data).
  • Embeds the UI screenshot (docs/img/synthetic_data_visibility.png).
  • Documents the /security:detect skill (detection-engineering-coverage-evaluation).
  • Outlines best practices, human-in-the-loop authorization gates, and prompt-injection defenses when consuming external threat reports.

2. SecOps MCP Server Documentation (docs/servers/secops_mcp.md)

  • Added Detection Engineering Agent Tools section detailing:
    • generate_threat_detection_opportunity
    • generate_synthetic_events
    • evaluate_rule_coverage_long_running
    • get_operation
    • generate_rules
  • Added Example 9: Agentic Detection Engineering Workflow demonstrating an end-to-end conversation from threat description to synthetic events, LRO evaluation, and candidate rule generation.

3. Extension & Navigation Updates

  • docs/google_secops_extension.md: Registered Skill 6 (detection-engineering-coverage-evaluation).
  • docs/toc.md: Added [Agentic Detection Engineering](agentic_detection_engineering.md) to the Table of Contents.
  • docs/index.md: Added quick link and description for Agentic Detection Engineering.

Verification

  • Built Sphinx HTML documentation locally (make -C docs html):
    make -C docs html
    # build succeeded, images copied: img/synthetic_data_visibility.png
    # HTML pages generated in docs/_build/html
  • Verified image rendering and cross-references.
  • Zero secrets committed (isolated .envrc and virtualenv ignored).

TAG=agy
CONV=b434fecb-6fd3-4841-b909-49d23ef70fa3

…ntation

Document Google SecOps Agentic Detection Engineering (ADE) APIs and workflows:
- Created `docs/agentic_detection_engineering.md` detailing the 8-stage lifecycle (TDO generation, synthetic telemetry simulation, sandboxed LRO rule coverage evaluation, gap analysis, and candidate YARA-L 2.0 rule synthesis).
- Embedded SecOps UI configuration for Synthetic Data Visibility (`docs/img/synthetic_data_visibility.png`).
- Updated `docs/servers/secops_mcp.md` with all 5 ADE MCP tools (`generate_threat_detection_opportunity`, `generate_synthetic_events`, `evaluate_rule_coverage_long_running`, `get_operation`, `generate_rules`) and Example 9 walkthrough.
- Updated `docs/google_secops_extension.md` to register Skill 6 (`detection-engineering-coverage-evaluation`).
- Updated `docs/toc.md` and `docs/index.md` navigation and quick links.

TAG=agy
CONV=b434fecb-6fd3-4841-b909-49d23ef70fa3
- Update evaluate_rule_coverage_long_running docs to show exclude_composite_coverage defaults to True.
- Fix TOOL_MAPPING link in docs/google_secops_extension.md to point to GitHub file location.

TAG=agy
CONV=b434fecb-6fd3-4841-b909-49d23ef70fa3
- Fix create_security_rule typo to match create_rule tool name.
- Clarify activation step instructions.

TAG=agy
CONV=b434fecb-6fd3-4841-b909-49d23ef70fa3
@dandye
dandye merged commit ef489af into add_de_agent_apis Sep 4, 2026
1 check passed
@dandye
dandye deleted the docs/de-agent branch September 4, 2026 02:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant