Skip to main content

MCP API Reference


OntoRamp exposes eleven tools across three MCP plugins: Knowledge Graph (governance and compliance search), Governance Evaluator (maturity gap analysis and document validation), and Projection Engine (governance assessment and domain-level findings). All tools are available via the MCP Streamable HTTP transport; legacy SSE-named aliases remain supported. This page documents every tool's parameters and response shape. Search relevance is returned as a coarse bucket — high, medium, or low — not a raw score.

Authentication

Every request requires an API key. Pass it in the Authorization header as a Bearer token (recommended), or as a query parameter on the legacy connection URL.

# Streamable HTTP endpoint (recommended)
POST https://mcp.ontoramp.com/{plugin}/mcp
Authorization: Bearer YOUR_API_KEY

# Legacy alias (query-parameter auth, still supported)
POST https://mcp.ontoramp.com/{plugin}/sse?api_key=YOUR_API_KEY

Replace {plugin} with one of: knowledge-graph, governance-evaluator, projection-engine.


Knowledge Graph

semantic_searchFree

Search governance and compliance knowledge by meaning. Use for SOC 2 readiness research, ISO 27001 control mapping, architecture maturity analysis, and AI governance assessment.

PARAMETERS

query*
stringNatural language search query (3–2,000 characters).
domain
stringFilter by governance domain (e.g. "governance", "security").
limit
numberMaximum results to return. Default 10, max 50.
similarity_threshold
numberMinimum similarity score (0–1). Default 0.3.

RESPONSE

{
  "results": [
    {
      "chunk_id": "uuid",
      "content_text": "...",
      "relevance": "high",
      "domain": "governance",
      "title": "...",
      "source_kind": "Governance Reference"
    }
  ],
  "total": 10,
  "query": "..."
}

keyword_searchFree

Search for specific framework requirements, named controls, and regulatory terminology. Full-text keyword search with OR matching across the governance knowledge base.

PARAMETERS

query*
stringKeyword search terms (max 500 characters). Terms are OR-matched.
domain
stringFilter by governance domain.
limit
numberMaximum results. Default 10, max 50.

RESPONSE

{
  "results": [
    {
      "chunk_id": "uuid",
      "content_text": "...",
      "relevance": "high",
      "domain": "governance",
      "title": "...",
      "source_kind": "Governance Reference"
    }
  ],
  "total": 10,
  "query": "..."
}

hybrid_searchPaid

Combined semantic and keyword search for highest-relevance results. Use for compliance gap assessment, governance maturity analysis, and cross-framework research.

PARAMETERS

query*
stringSearch query (3–2,000 characters). Used for both semantic and keyword matching.
domain
stringFilter by governance domain.
limit
numberMaximum fused results. Default 10, max 50.
similarity_threshold
numberMinimum similarity for the semantic component (0–1). Default 0.3.
semantic_weight
numberWeight for semantic results in fusion (0–1). Default 0.6. Keyword weight is 1 - semantic_weight.

RESPONSE

{
  "results": [
    {
      "chunk_id": "uuid",
      "content_text": "...",
      "relevance": "high",
      "domain": "governance",
      "title": "...",
      "source_kind": "Governance Reference"
    }
  ],
  "total": 10,
  "query": "..."
}

entity_searchFree

Search governance entities — governance concepts, patterns, systems, and roles — and their relationships. Find specific governance structures and how they connect.

PARAMETERS

query*
stringEntity name or description to search for (2–500 characters).
entity_type
enumFilter by entity type: governance_concept, system, interface_term, boundary_condition, pattern, invariant, or role.
similarity_threshold
numberMinimum similarity score (0–1). Default 0.3.
include_chunks
booleanInclude linked chunk IDs for each entity. Default false.
limit
numberMaximum entities to return. Default 10, max 50.

RESPONSE

{
  "results": [
    {
      "entity_title": "Data Governance Board",
      "entity_type": "role",
      "definition_text": "...",
      "synonyms": ["..."],
      "domain": "governance",
      "relevance": "high",
      "chunk_ids": ["uuid", "uuid"]
    }
  ],
  "total": 10,
  "query": "..."
}

edge_traversalPaid

Trace structural relationships between governance documents across the knowledge graph. Edge families are returned in plain language — "relates to", "depends on", "is derived from".

PARAMETERS

document_uid*
stringUUID of the starting document in the document registry.
depth
numberNumber of hops to traverse. Default 1, max 3.
edge_families
string[]Filter by edge family (e.g. "semantic_similarity", "structural_containment").

RESPONSE

{
  "edges": [
    {
      "edge_id": "uuid",
      "source_document_uid": "uuid",
      "target_document_uid": "uuid",
      "source_entity_uid": null,
      "target_entity_uid": null,
      "edge_family": "depends on",
      "relevance": "high",
      "source_domain": "governance",
      "target_domain": "security",
      "hop_distance": 1
    }
  ],
  "total": 12,
  "document_uid": "uuid",
  "depth": 1
}

Governance Evaluator

get_maturity_gapFree

Assess governance maturity coverage across the seven domains. Returns entity coverage by type, identified gaps, and where to start. Use for SOC 2 readiness, ISO 27001 gap analysis, NIST CSF assessment, and digital transformation readiness.

PARAMETERS

domain
stringGovernance domain to analyze (e.g. "governance", "security"). Omit for a cross-domain summary.
include_top_entities
booleanInclude the top entities by type for the domain. Default true.

RESPONSE

{
  "domain": "governance",
  "total_entities": 128,
  "total_chunks": 512,
  "coverage_by_type": [
    {
      "entity_type": "governance_concept",
      "count": 42,
      "percentage": 32.8
    }
  ],
  "gaps": ["..."],
  "top_entities": [
    { "title": "...", "type": "pattern" }
  ],
  "assessment_cta": "..."
}

lint_documentPaid

Validate any governance document against the knowledge graph. Returns a structured lint report with findings by severity, entity coverage, and domain alignment. Use for audit readiness assessment, policy review, and compliance documentation validation.

PARAMETERS

content*
stringDocument text to analyze (50–10,000 characters).
domain
stringExpected domain (e.g. "governance", "platform"). If provided, domain misalignment is flagged.
severity_threshold
enumMinimum severity to include: info, warning, or error. Default info.

RESPONSE

{
  "findings": [
    {
      "rule": "...",
      "severity": "warning",
      "message": "...",
      "suggestion": "..."
    }
  ],
  "entity_coverage": {
    "matched_entities": [
      {
        "entity_title": "...",
        "entity_type": "governance_concept",
        "relevance": "high"
      }
    ],
    "total_matched": 11
  },
  "domain_analysis": {
    "detected_domains": [
      { "domain": "governance", "chunk_count": 8 }
    ],
    "expected_domain": "governance",
    "aligned": true
  },
  "summary": {
    "total_findings": 4,
    "errors": 0,
    "warnings": 2,
    "info": 2,
    "entity_coverage_score": 0.79
  }
}

generate_briefPaid

Generate evidence-linked governance briefs with full source citations. Use for board readiness reports, technology due diligence summaries, and compliance documentation.

PARAMETERS

topic*
stringThe governance topic to brief on (5–500 characters).
depth
enumBrief depth: "summary" (3–5 sentences) or "detailed" (full analysis). Default "summary".
domain
stringFocus domain (e.g. "governance", "platform"). Omit for cross-domain.
max_sources
numberMaximum source chunks to cite. Default 5, max 20.

RESPONSE

{
  "topic": "...",
  "brief": "...",
  "sources": [
    {
      "chunk_id": "uuid",
      "content_preview": "...",
      "domain": "governance",
      "relevance": "high"
    }
  ],
  "entities": [
    {
      "entity_title": "...",
      "entity_type": "governance_concept",
      "definition_text": "..."
    }
  ],
  "domain_coverage": [
    { "domain": "governance", "source_count": 3 }
  ],
  "metadata": {
    "depth": "summary",
    "sources_used": 5,
    "entities_found": 3,
    "model": "..."
  }
}

Projection Engine

get_simulation_statusFree

Check governance assessment progress and results. Returns domain-level maturity scores, overall posture, and assessment completion status.

PARAMETERS

run_id
stringSpecific run UUID to query. Omit for the most recent runs.
limit
numberNumber of recent runs to return. Default 5, max 20. Ignored when run_id is provided.
status_filter
enumFilter runs by status: completed, running, failed, or all. Default all.

RESPONSE

{
  "runs": [
    {
      "run_id": "uuid",
      "status": "completed",
      "assessment": {
        "overall_score": 78.5,
        "posture_state": "...",
        "domain_scores": {
          "GOVERNANCE": 88.1,
          "PLATFORM": 76.4,
          "SECURITY": 79.3,
          "AI": 82.0,
          "DATA": 65.0
        }
      },
      "assessment_summary": {
        "artifacts_assessed": 512,
        "domain_coverage": { "governance": 128 }
      },
      "started_at": "2026-04-06T10:00:00Z",
      "completed_at": "2026-04-06T10:00:03Z",
      "source": "own",
      "is_bootstrap": false
    }
  ],
  "total": 1
}

get_decision_packetsFree

Retrieve domain-level governance assessment findings with evidence, rationale, and confidence levels. Each finding includes specific gaps and recommended actions.

PARAMETERS

run_id
stringFilter packets by projection run UUID.
domain
stringFilter to a specific domain. Omit for all domains.
recommendation
enumFilter by recommendation: APPROVE, CONDITIONAL_APPROVE, REJECT, or DEFER.
limit
numberMaximum packets to return. Default 10, max 50.

RESPONSE

{
  "packets": [
    {
      "packet_id": "uuid",
      "simulation_run_id": "uuid",
      "domain": "governance",
      "question": "...",
      "recommendation": "APPROVE",
      "confidence": 0.917,
      "rationale": "...",
      "governed_by": "...",
      "score_summary": {
        "overall_score": 91.7,
        "posture_state": "...",
        "domain_scores": { "GOVERNANCE": 88.1 }
      },
      "compliance_summary": {
        "checks_passed": 6,
        "checks_total": 6
      },
      "created_at": "2026-04-06T10:00:00Z",
      "source": "own",
      "is_bootstrap": false
    }
  ],
  "total": 6
}

run_projectionPaid

Run a new governance maturity assessment. Evaluates your governance landscape and produces domain-level findings synchronously — scores and packet counts return in the same call.

PARAMETERS

domain
stringDomain to project (e.g. "governance", "ai"). Omit for a full-graph projection.
scenario_code
stringOptional scenario identifier. Auto-generated if omitted.
dry_run
booleanCompute the projection without persisting results. Default false.

RESPONSE

{
  "run_id": "uuid",
  "status": "completed",
  "overall_score": 78.5,
  "posture_state": "...",
  "domain_scores": {
    "GOVERNANCE": 88.1,
    "PLATFORM": 76.4,
    "SECURITY": 79.3,
    "AI": 82.0,
    "DATA": 65.0
  },
  "packets_created": 6,
  "persisted": true,
  "started_at": "2026-04-06T10:00:00Z",
  "completed_at": "2026-04-06T10:00:03Z"
}

Rate limits

PluginFreeOrg
Knowledge GraphFair-use monthly allowanceUnlimited — flat monthly rate
Governance EvaluatorFair-use monthly allowanceUnlimited — flat monthly rate
Projection EngineFair-use allowance; running projections is Org tierUnlimited — flat monthly rate

When a request is rate-limited, the rejection itself is the signal — an HTTP 429 response or an in-band RATE_LIMITED error in the tool result, depending on the plugin. Responses do not carry X-RateLimit-* headers; on a rejection, back off and retry after the reset.

Hitting the free-tier quota? Org tier is unlimited at a flat monthly rate — see plugin pricing.


Error codes

401Missing or invalid API key.
403API key does not have access to the requested plugin.
429Rate limit exceeded. The response body includes reset_date. Free-tier quotas reset monthly; Org tier removes them (see Rate limits above).
422Invalid parameters. Check the error.details field for specifics.
500Internal server error. Retry with exponential backoff.
503Service temporarily unavailable. The projection engine may be under load.