llm_instructions_get
Retrieve usage instructions for Microsoft Sentinel MCP Server tools to understand how to interact with security data and operations.
Instructions
Retrieve the LLM usage instructions for the Sentinel MCP Server. Use this tool first before all other tools.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kwargs | Yes |
Implementation Reference
- tools/tool_docs_tools.py:153-188 (handler)The LLMInstructionsGetTool class defines the tool with name 'llm_instructions_get' and implements the 'run' method that reads and returns the LLM instructions from docs/llm_instructions.md.
class LLMInstructionsGetTool(MCPToolBase): """Tool for retrieving the LLM usage instructions for the Sentinel MCP Server.""" name = "llm_instructions_get" description = ( "Retrieve the LLM usage instructions for the Sentinel MCP Server. " "Use this tool first before all other tools." ) async def run(self, ctx, **kwargs) -> Any: """ Retrieve the LLM usage instructions for the Sentinel MCP Server. Args: ctx: The tool context (unused). **kwargs: Optional arguments (unused). Returns: dict: { 'content': raw markdown content of docs/llm_instructions.md, 'error': error message if file cannot be read } """ # Defensive: handle string, None, or dict for kwargs (even if unused) # No parameters to extract, but we'll normalize kwargs for consistency # using the centralized parameter extraction from MCPToolBase _ = self._extract_param(kwargs, "") try: llm_path = Path(__file__).parent.parent / "docs" / "llm_instructions.md" content = llm_path.read_text(encoding="utf-8") return {"content": content} except Exception as e: return {"error": f"Failed to read LLM instructions: {e}"} - tools/tool_docs_tools.py:190-196 (registration)The register_tools function registers the LLMInstructionsGetTool (and other doc tools) to the MCP server instance.
def register_tools(mcp): """Register all documentation tools with the given MCP server instance.""" ToolDocsListTool.register(mcp) ToolDocsGetTool.register(mcp) ToolDocsSearchTool.register(mcp) LLMInstructionsGetTool.register(mcp)