Support Tools - Optix MCP Server

health_check

Returns server status, version, uptime, and list of available tools. Use this to verify the server is running and check which tools are enabled.

Parameters

None required.

Example

MCP Tool Call

health_check()

Response

json

{
  "status": "healthy",
  "server_name": "optix-mcp-server",
  "version": "1.0.0",
  "uptime_seconds": 3600,
  "tools_available": [
    "health_check",
    "security_audit",
    "a11y_audit",
    "devops_audit",
    "principal_audit",
    "generate_report",
    "pr_comment",
    "open_dashboard"
  ]
}

generate_report

Generate a standardized markdown report from a completed audit workflow. The report is numbered and saved to the reports/ directory.

Parameters

Parameter	Type	Required	Description
continuation_id string	Optional	UUID of completed workflow. If omitted, uses most recent workflow.

Example

MCP Tool Call

generate_report(
  continuation_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

Response

json

{
  "status": "success",
  "report_path": "reports/003_SECURITY_AUDIT_REPORT.md",
  "report_number": 3,
  "audit_type": "security",
  "findings_count": 12
}

pr_comment

Post audit findings as a formatted comment on a GitHub Pull Request. Integrates with GitHub CLI (gh) for authentication.

Parameters

Parameter	Type	Required
pr_number integer	Optional	PR number to comment on. If omitted, lists recent PRs.
continuation_id string	Optional	UUID of completed workflow. Uses most recent if omitted.
include_file_links boolean	Optional	Add GitHub permalinks to file references. Default: false.
repo string	Optional	Repository in owner/repo format. Auto-detected if omitted.

List Recent PRs

MCP Tool Call

pr_comment()

Post to Specific PR

MCP Tool Call

pr_comment(
  pr_number=42,
  include_file_links=true
)

Response (List PRs)

json

{
  "status": "pr_list",
  "message": "Select a PR to comment on",
  "recent_prs": [
    {"number": 42, "title": "Add user authentication", "author": "dev1"},
    {"number": 41, "title": "Fix API endpoint", "author": "dev2"},
    {"number": 40, "title": "Update dependencies", "author": "dev1"}
  ]
}

Response (Comment Posted)

json

{
  "status": "success",
  "pr_number": 42,
  "comment_url": "https://github.com/org/repo/pull/42#issuecomment-123456",
  "findings_posted": 12
}

Authentication Required

This tool requires GitHub CLI (gh) to be installed and authenticated. Run gh auth login first.

open_dashboard

Opens the Optix web dashboard in your default browser. The dashboard provides a visual interface for monitoring active audits and viewing findings.

Parameters

None required.

Example

MCP Tool Call

open_dashboard()

Response

json

{
  "status": "success",
  "message": "Dashboard opened in browser",
  "url": "http://localhost:8765"
}

Dashboard Features

Real-time audit progress monitoring
Findings viewer with severity filtering
File explorer showing affected files
Activity feed for recent events
Report download and PR posting