Skip to content

MCP Resources and Tools

The Ogma MCP server is for external MCP clients such as Codex, Claude Code, Cursor, and other Model Context Protocol hosts. It is separate from the in-app AI assistant.

MCP exposes three surfaces:

  • Resources: named read targets that an MCP client can open.
  • Resource templates: parameterized read targets for a specific entry, finding, workflow, run, export, or Replay object.
  • Tools: callable actions. Some are read-only. Some require server startup flags.

For startup flags and client configuration, see MCP setup.

Resources

ResourceWhat it returns
ogma://statusCurrent backend health and status.
ogma://projectsAll Ogma projects.
ogma://project/currentCurrent active project.
ogma://instancesProxy listener instances.
ogma://http-history/recent20 most recent HTTP entries without body content.
ogma://ws-history/recent20 most recent WebSocket connections.
ogma://findingsUp to 50 findings.
ogma://workflowsConfigured workflows.
ogma://workflow-runs/recent20 most recent workflow run records.
ogma://migration/workflowsWorkflow migration compatibility report.
ogma://exports/recent10 most recent export jobs.
ogma://capabilitiesMCP server capability summary.
ogma://mcp/permissionsCurrent MCP permission flags.
ogma://replay/sessions/recent20 most recent Replay sessions.

Resource Templates

TemplateWhat it returns
ogma://http-history/{entry_id}One HTTP history entry.
ogma://ws-history/{connection_id}One WebSocket connection.
ogma://findings/{finding_id}One finding.
ogma://workflows/{workflow_id}One workflow.
ogma://workflow-runs/{run_id}One workflow run.
ogma://exports/{export_id}One export job.
ogma://replay/sessions/{session_id}One Replay session.
ogma://replay/attempts/{session_id}/{attempt_id}One Replay attempt.
ogma://workflow-safety/{workflow_id}Workflow safety classification and required permissions.

Tool Permissions

Most inspection tools are always available. Mutating or outbound actions are controlled by ogma-mcp startup flags:

Permission flagEnables
--allow-write-findingsFinding create, update, tag, link, and delete actions.
--allow-export-dataExport job creation and export download metadata.
--allow-send-requestsReplay send, raw HTTP request, bulk request, login test, fetch URL, and request repetition tools.
--allow-run-workflowsWorkflow and Automate execution tools.
--allow-intercept-controlIntercept queue mutation and intercept state control.

Tool Catalog

HTTP History and Querying

ToolWhat it does
ogma_search_http_historySearches HTTP history with HTTPQL and returns request/response metadata.
ogma_get_http_entryGets one HTTP entry by ID, optionally with body previews.
ogma_get_http_entry_bodyGets full request and/or response body for an HTTP entry.
ogma_validate_httpqlValidates an HTTPQL expression.
ogma_analyze_http_entry_securityReviews one HTTP entry for security-relevant behavior and evidence.
ogma_search_by_vulnerability_patternSearches captured traffic for vulnerability-oriented patterns.

WebSocket and SSE

ToolWhat it does
ogma_search_ws_historySearches WebSocket connection history with StreamQL.
ogma_get_ws_messagesGets stored messages for one WebSocket connection.
ogma_validate_streamqlValidates a StreamQL expression.
ogma_get_ws_messages_liveGets live WebSocket messages captured from browser instrumentation.
ogma_create_ws_replay_sessionCreates a WebSocket Replay session.
ogma_connect_ws_replayConnects a WebSocket Replay session.
ogma_send_ws_replay_messageSends a message through a WebSocket Replay session.
ogma_list_ws_replay_sessionsLists WebSocket Replay sessions.
ogma_browser_get_ws_framesReads WebSocket frames captured by the embedded browser.
ogma_browser_start_ws_captureStarts browser-side WebSocket frame capture.
ogma_browser_send_ws_messageSends a WebSocket message from browser context.

Findings and Evidence

ToolWhat it does
ogma_search_findingsSearches findings by severity, reporter, text, limit, and offset.
ogma_get_findingGets one finding by ID.
ogma_preview_finding_from_evidencePreviews a finding draft from an HTTP entry without creating it.
ogma_create_findingCreates a finding with metadata, tags, confidence, remediation, and optional evidence links.
ogma_update_findingUpdates an existing finding.
ogma_add_finding_tagAdds tags to a finding without replacing existing tags.
ogma_link_finding_evidenceLinks HTTP, Replay, Automate, or WebSocket evidence to a finding.
ogma_delete_findingDeletes a finding.
ogma_create_world_class_findingCreates a detailed finding with structured evidence, PoC, remediation, and vulnerability type.
ogma_get_finding_evidence_summarySummarizes linked evidence for a finding.
ogma_export_findings_reportCreates a findings report export.

Exports

ToolWhat it does
ogma_preview_export_planPreviews export contents and format without creating a job.
ogma_create_export_jobCreates an export job for history, search results, findings, or Automate results.
ogma_get_export_jobGets one export job by ID.
ogma_list_export_jobsLists export jobs.
ogma_get_export_download_infoGets download metadata for a completed export.

Replay and Request Sending

ToolWhat it does
ogma_preview_replay_sendPreviews a Replay send and returns a confirmation token.
ogma_send_replay_requestSends a Replay request with the confirmation token.
ogma_create_replay_session_from_historyCreates a Replay session from a captured HTTP entry.
ogma_create_replay_session_rawCreates a Replay session from a raw request definition.
ogma_get_replay_sessionGets Replay session metadata.
ogma_get_replay_attemptGets one Replay attempt.
ogma_list_replay_sessionsLists Replay sessions.
ogma_repeat_requestRepeats an existing request with optional changes.
ogma_http_requestSends a direct HTTP request through the MCP tool surface.
ogma_bulk_send_requestsSends a batch of requests.
ogma_fetch_urlFetches a URL and returns response status, headers, and body preview.
ogma_test_loginTests a login endpoint with supplied or default credential pairs and reports evidence.

Workflows and Automate

ToolWhat it does
ogma_search_workflowsLists and filters workflows.
ogma_get_workflowGets one workflow by ID.
ogma_get_workflow_runGets one workflow run record.
ogma_validate_workflow_importValidates a workflow bundle for import compatibility.
ogma_get_workflow_safetyGets safety and permission classification for a workflow.
ogma_preview_workflow_runPreviews a workflow run before execution.
ogma_run_workflowRuns a workflow.
ogma_cancel_workflow_runCancels a workflow run.
ogma_list_automate_sessionsLists Automate sessions.
ogma_get_automate_sessionGets one Automate session.
ogma_create_automate_sessionCreates an Automate session.
ogma_run_automate_sessionRuns an Automate session.
ogma_list_automate_runsLists Automate runs.
ogma_get_automate_runGets one Automate run.
ogma_cancel_automate_runCancels an Automate run.
ogma_list_automate_resultsLists Automate results.
ogma_get_automate_resultGets one Automate result.
ogma_load_skillLoads built-in MCP skill guidance into the assistant context.

Scanner

ToolWhat it does
ogma_run_passive_scanRuns passive scanner checks for one HTTP entry.
ogma_run_passive_scan_allRuns passive scanner checks across captured history.
ogma_list_scanner_rulesLists scanner detection rules.

Intercept

ToolWhat it does
ogma_get_intercept_statusGets current intercept state.
ogma_set_intercept_enabledEnables or disables intercept.
ogma_list_intercept_queueLists queued intercepted items.
ogma_get_intercept_itemGets one queued intercept item.
ogma_forward_intercept_itemForwards an intercepted item, optionally modified.
ogma_drop_intercept_itemDrops an intercepted item.

Proxy, Scope, and Network

ToolWhat it does
ogma_list_proxy_listenersLists proxy listeners.
ogma_start_proxy_listenerStarts a proxy listener.
ogma_stop_proxy_listenerStops a proxy listener.
ogma_list_scope_presetsLists scope presets.
ogma_get_active_scopeGets the active scope.
ogma_set_active_scopeSets the active scope.
ogma_local_ipsLists local IP addresses useful for listeners and callbacks.
ogma_get_tls_infoGets TLS information for a target or captured connection.

Sitemap, Endpoints, and OAST

ToolWhat it does
ogma_get_sitemapGets the captured sitemap.
ogma_get_sitemap_parametersGets parameters discovered for sitemap entries.
ogma_list_extracted_endpointsLists endpoints extracted from traffic and frontend content.
ogma_import_openapi_specImports an OpenAPI specification to seed endpoints and request shapes.
ogma_get_oast_configGets OAST listener configuration.
ogma_list_oast_interactionsLists OAST interactions.

History Annotation

ToolWhat it does
ogma_set_entry_colorSets the color label for a history entry.
ogma_add_entry_tagAdds a tag to a history entry.
ogma_remove_entry_tagRemoves a tag from a history entry.

Browser Control

ToolWhat it does
ogma_browser_launchLaunches the Ogma browser.
ogma_browser_navigateNavigates the browser to a URL.
ogma_browser_screenshotCaptures browser page state.
ogma_browser_execute_jsExecutes JavaScript in the browser.
ogma_browser_get_sourceGets the current page DOM source.
ogma_browser_get_cookiesGets browser cookies.
ogma_browser_set_cookieSets a browser cookie.
ogma_browser_new_tabOpens a new browser tab.
ogma_browser_close_tabCloses a browser tab.
ogma_browser_get_tabsLists browser tabs.
ogma_browser_clickClicks at browser coordinates or target metadata.
ogma_browser_type_textTypes text into the browser.
ogma_browser_fill_inputFills an input field.
ogma_browser_click_selectorClicks an element by selector.
ogma_browser_submit_formSubmits a form.
ogma_browser_get_page_linksExtracts links from the current page.
ogma_browser_get_page_formsExtracts forms from the current page.
ogma_browser_scrollScrolls the current page.
ogma_browser_wait_for_selectorWaits for an element selector.
ogma_browser_get_network_logGets browser network events.
ogma_browser_go_backGoes back in browser history.
ogma_browser_go_forwardGoes forward in browser history.
ogma_browser_reloadReloads the page.
ogma_browser_find_textFinds text in the current page.
ogma_browser_clear_dataClears browser data.

Utilities and Analysis

ToolWhat it does
ogma_fetch_sourcemapFetches and inspects a JavaScript source map.
ogma_proto_decodeDecodes protobuf payloads using configured schemas.
ogma_decode_jwtDecodes JWT headers and claims.
ogma_search_js_secretsSearches JavaScript responses for exposed secrets and endpoints.
ogma_compare_responsesCompares two responses.
ogma_bytes_transformPerforms byte transforms such as encoding, decoding, XOR, hashing, and extraction.
ogma_wasm_inspectInspects a WebAssembly module.
ogma_fingerprint_targetIdentifies target technology from captured traffic and responses.
ogma_thinkRecords structured reasoning or plan text inside the MCP session.
ogma_explain_capabilitiesReturns the MCP server capability summary.

Match and Replace

ToolWhat it does
ogma_list_match_replace_rulesLists Match & Replace rules.
ogma_create_match_replace_ruleCreates a Match & Replace rule.
ogma_toggle_match_replace_ruleEnables or disables a Match & Replace rule.
ogma_delete_match_replace_ruleDeletes a Match & Replace rule.

Environment Variables

ToolWhat it does
ogma_list_env_varsLists environment variable names and metadata.
ogma_set_env_varCreates or updates an environment variable.
ogma_get_env_var_valueReads an environment variable value when permitted.

Projects, Notes, Todos, and Session

ToolWhat it does
ogma_list_projectsLists projects.
ogma_switch_projectSwitches the active project.
ogma_note_createCreates a note.
ogma_note_listLists notes.
ogma_note_getGets one note.
ogma_note_updateUpdates a note.
ogma_note_deleteDeletes a note.
ogma_todo_createCreates a todo.
ogma_todo_listLists todos.
ogma_todo_updateUpdates a todo.
ogma_todo_mark_doneMarks a todo done.
ogma_todo_deleteDeletes a todo.
ogma_finish_sessionFinalizes the MCP session with summary, methodology, and recommendations.
ogma_get_session_reportGets the current MCP session report.

Relationship to Workspace AI

The MCP server is a protocol server used by external tools. The in-app Workspace AI is a Vue/browser feature that calls configured AI providers directly and exposes its own frontend tool list. See Workspace AI.

Released under the GNU AGPLv3 license.