Zum Hauptinhalt springen

API & MCP

The debug server (REST API) and the MCP server are part of Inkra Pro (EUR 7.99 per month or EUR 79.99 per year) and are only included in the version from our store, not in the one from the Mac App Store.

Debug Server

The debug server is a local TCP server (NWListener) that can be enabled in settings. It provides a JSON-based API for external automation.

Authentication: Every request must include the configured token in the Authorization: Bearer <token> header.

EndpointDescription
GET /healthCheck server availability
GET /documentGet current document
POST /documentSet document content
GET /statusEditor status (word count, file, etc.)

MCP Server

The MCP server (inkra-mcp-server) ships as a standalone CLI tool inside the app bundle. It implements the Model Context Protocol and communicates with the main app via XPC. AI assistants like Claude Code can access the editor through it.

Configuration is done through the MCP settings of the respective AI client. The server starts automatically when a client connects.

Automation

External scripts and tools can access the editor via the debug server. Typical use cases:

  • Read and write document content programmatically
  • Query editor status (open file, word count)
  • Integration into CI/CD pipelines or documentation workflows
  • Control by AI assistants via MCP