MCP

Use the MortgageGuidelines MCP endpoint to give MCP-compatible AI clients access to sourced mortgage guideline answers, available source discovery, and conversation history.

MCP uses the same public API keys, tenant source controls, scopes, rate limits, request logging, and response shapes as the REST API.

Before You Start

You need:

A MortgageGuidelines public API key
The hosted MCP endpoint for your environment
The scopes required by the tools your client should use

For most integrations, the endpoint is:

https://mcp.mortgageguidelines.com/mcp

Use the endpoint provided for your account if your environment uses a dedicated hostname.

Client Configuration

Add the MCP server to your AI client and pass your public API key as an authorization header.

{
  "mcpServers": {
    "mortgageguidelines": {
      "url": "https://mcp.mortgageguidelines.com/mcp",
      "headers": {
        "Authorization": "Bearer mgapi_live_your_key_here"
      }
    }
  }
}

You can also authenticate with X-API-Key if your client supports custom headers:

X-API-Key: mgapi_live_your_key_here

The MCP service validates the key and filters tools, resources, and prompts by the scopes on that key.

Browser Clients

Browser-based MCP clients send an Origin header. Ask MortgageGuidelines to allow the exact origin for your app before connecting from the browser.

Examples:

https://app.example.com
https://staging.example.com

Server-side and desktop MCP clients usually do not send an Origin header.

Tools

Tool	Required scope	REST API
`mortgageguidelines.get_key_details`	Any authenticated key	`GET /v1/me`
`mortgageguidelines.list_sources`	`sources:read`	`GET /v1/sources`
`mortgageguidelines.create_conversation`	`chat:write`	`POST /v1/conversations`
`mortgageguidelines.send_message`	`chat:write`	`POST /v1/messages`
`mortgageguidelines.get_conversation`	`chat:read`	`GET /v1/conversations/{conversation_id}`
`mortgageguidelines.list_conversation_messages`	`chat:read`	`GET /v1/conversations/{conversation_id}/messages`
`mortgageguidelines.send_conversation_message`	`chat:write`	`POST /v1/conversations/{conversation_id}/messages`

idempotency_key is accepted on write tools and forwarded as the REST Idempotency-Key header.

Resources

Resource	Description
`mg://openapi`	OpenAPI document for the public REST API.
`mg://sources`	Available sources for the authenticated key.
`mg://conversations/{conversation_id}`	Conversation metadata.
`mg://conversations/{conversation_id}/messages`	Stored messages for a conversation.

Prompts

Prompt	Required scopes	Description
`ask_guideline_question`	`chat:write`	Start a sourced guideline question.
`continue_conversation`	`chat:write`	Ask a follow-up question in an existing conversation.
`compare_guidelines`	`chat:write`, `sources:read`	Compare available guideline sources.

Responses

Tool results include structured JSON and a readable JSON text block for client compatibility.

Public API fields such as request_id, conversation_id, message_id, response, citations, sources, and metadata are preserved.

Streaming answers remain available through the REST API by calling /v1/messages directly with stream: true.