docs(audit): reconcile LLM-tool descriptions with [Description] attributes in code#20
Merged
Merged
Conversation
…butes in code Pass 3 of the 2026-05 docs audit: cross-checked the LLM-visible AIFunction inventory in src/Drederick/Agent/LlmExploitTools.cs and LlmNotebookTool.cs against doc claims. Drift fixed: - docs/MODEL_BEHAVIOR.md L328: example tool list named 'password_spray', but the actual AIFunction registered by LlmExploitTools.BuildAiFunctions is 'execute_cred_spray' (LlmExploitTools.cs:238). The 'password-spray' string elsewhere (DB_SCHEMA.md, FIGHTS.md, MODEL_BEHAVIOR.md L97) refers to the underlying IExploitTool name and is correct as-is. Replaced the placeholder row with the full LLM-visible tool list (13 wrappers) plus the per-flag permission gate summary, and pointed at the [Description] attribute as the canonical wording source. No code changes. No other doc-vs-code drift found in the LLM-tool surface (take_note params match LlmNotebookTool.TakeNoteAsync exactly: category, body, tags[], target_host). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pass 3 of 2026-05 docs audit — LLM-tool doc-vs-code coherence
Cross-checked every
[Description]-decoratedAIFunctionregistered by the LLM tool catalog against doc claims indocs/MODEL_BEHAVIOR.md,docs/LEARNING_LOOP.md,docs/FIGHTS.md,AGENTS.md, and.github/copilot-instructions.md.Tool inventory verified (14 LLM-visible tools)
Recon (
LlmToolCatalogoverReconToolbox):nmap_scan,http_probe,tls_probe,dns_probe,smb_probe,ftp_probe,ssh_probe,snmp_probe,ldap_probe,rpc_probe,kerberos_probe,dns_zone_transfer,http_content_discovery,tls_cipher_enum(conditionally registered viaAddIf).Exploit (
LlmExploitTools.BuildAiFunctions):exploit_plan,execute_cred_spray,run_post_ex_linux,run_post_ex_windows,pivot_and_scan,extract_flags_from_dir,run_multi_stage,generate_macro,deliver_phish_smb,deliver_phish_webdav,start_phish_stager,exec_shell,get_cms_chain_template.Notebook (
LlmNotebookTool):take_note— paramscategory,body,tags[],target_host.Drift fixed
execute_cred_spraysrc/Drederick/Agent/LlmExploitTools.cs:238docs/MODEL_BEHAVIOR.md:328listed it aspassword_spray[Description]as the canonical wording source.Note: The strings
password-sprayindocs/DB_SCHEMA.md:166,docs/FIGHTS.md:137, anddocs/MODEL_BEHAVIOR.md:97refer to the underlyingIExploitTool.Name(the kebab-case tool registered withExploitToolbox), not the LLM-visibleAIFunctionname. Those are correct and were not touched.take_notecross-checkLlmNotebookTool.TakeNoteAsyncsignature:category(string),body(string),tags?(string[]),target_host?(string)Doc claims in
docs/MODEL_BEHAVIOR.md:329((category, body, tags[], optional target_host)),docs/LEARNING_LOOP.md:205-247, anddocs/FIGHTS.md:187-208all match the[Description]strings on the method and parameters. No drift.Code-side flags
None. Every
[Description]attribute onLlmExploitTools.csandLlmNotebookTool.csis consistent with its method/parameter signature and behavior. No stale parameter descriptions found.Files changed
docs/MODEL_BEHAVIOR.md— one row in the LLM-visible tools table.No code touched. No other docs altered.