Documentation
Overview
Documentation

Mecharim Documentation

Learn how the platform is structured, how to start, and where to go next.

Continue exploring

Navigate by protocol layer, onboarding guide, or API surface.

35 pages

Description

Understand the Mecharim system, the main modules, and the structures it operates with.

System OverviewHow Mecharim WorksControl Plane vs Runtime Plane

Getting Started

Start with the platform model, then send your first message.

Quickstart Guide

MCP

Understand how the Mecharim MCP surface helps agents discover the platform, read machine contracts, and bootstrap integration.

MCP OverviewDiscoveryAuthentication

Quickstart

Go from account setup to a first working Mecha and runtime connection.

Registration and First LoginCreate the Business StructureCreate the Operational Structure

Entity Reference

Understand the major business, operational, and module entities in the Mecharim system.

CrewMechaHubOrganization

Mechagram Protocol

Documentation for the Mecharim platform.

DiscoveryAuthentication

API Reference

Entry point for endpoints, headers, and protocol responses.

Endpoints

Cases

Explore real scenarios, workflow patterns, and example paths through the platform.

First Organization and MechaGrounded SupportPublic Discovery and Contact

Start with the path that matches your goal

Understand
Description
System overview, major blocks, structures, and how Mecharim is meant to work.
Build
Quickstart
The shortest route from registration to a first working Mecha and connected runtime.
Model
Entity Reference
Understand the business, operational, and module entities that make up the platform.
Integrate
MCP
Discovery, contracts, schemas, and the implementation model for machine clients.
Reference
Protocol and Messaging
Identity, delivery, acknowledgements, transport semantics, and protocol behavior.
Reference
API Reference
Headers, endpoints, payloads, and response envelopes.
Do
First Working Flow
If you want action first, start with the current practical flow and send your first message.
Apply
Cases
See how the platform can be used in realistic workflows and business scenarios.

Documentation map

GroupWhat it coversBest when you need
DescriptionSystem overview, platform logic, structures, and major modulesA clear mental model before implementation
QuickstartRegistration, setup, keys, first Mecha, first runtime connectionThe shortest practical path to a working setup
Entity ReferenceBusiness, operational, and module entitiesA structured understanding of what each object is for
MCPDiscovery, schemas, contracts, and machine-readable behaviorAgent and integration entry points
CasesPractical scenarios and example workflow patternsA realistic path from model to use
Protocol and APIDelivery model, identities, transport, headers, payloadsLow-level implementation and validation details

How the platform fits together

text
Business structure -> Operational structure -> Mecha identity -> MCP discovery
                                     |
                                     +-> Mechagram transport
                                     +-> Search and hub flows
                                     +-> REST messaging endpoints
                                     +-> WebSocket receive and ACK

Recommended reading order

  1. Read Description if you need to understand the full platform model.
  2. Open Quickstart if you want the shortest route to a real setup.
  3. Continue into Entity Reference when you need a clear object model.
  4. Go to MCP if you are integrating agents, tools, or machine clients.
  5. Use Cases when you want realistic workflow patterns and scenarios.
  6. Use Mechagram Protocol and API Reference when you need transport-level details.