Loading server...
{
"type": "object",
"properties": {
"project": {
"type": "object",
"description": "A project in the Mokxi AI format: {\"format\": \"mokxi-ai/1\", \"name\": \"...\", \"board\": \"uno\", \"parts\": [{\"id\": \"led1\", \"type\": \"led\"}], \"wires\": [[\"board.13\", \"led1.A\"]], \"code\": {\"sketch.ino\": \"...\"}}. get_project_format has the full rules.",
"properties": {
"format": {
"type": "string",
"const": "mokxi-ai/1"
},
"name": {
"type": "string"
},
"board": {
"type": [
"string",
"null"
],
"description": "A board type from list_boards, such as \"uno\", \"esp32\" or \"pico\"; null for a circuit with no board."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"props": {
"type": "object"
}
},
"required": [
"id",
"type"
]
}
},
"wires": {
"type": "array",
"description": "Pairs of ends, \"partId.pin\"; the board is \"board\". A third item may name a color.",
"items": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 2,
"maxItems": 3
}
},
"code": {
"type": "object",
"description": "File name to its text: {\"sketch.ino\": \"...\"} or {\"main.py\": \"...\"}."
}
},
"required": [
"board"
]
}
},
"required": [
"project"
]
}
Starter example
get_example
A complete, working starter for a board, a part or both: a real Mokxi template, returned as a project with its wiring and code in the Mokxi AI format. With no arguments, the smallest whole project.
Schema valid · SHA-256 2d7488b8a66d…
View input schema
{
"type": "object",
"properties": {
"board": {
"type": "string",
"description": "A board type from list_boards, such as \"uno\" or \"esp32\"."
},
"part": {
"type": "string",
"description": "A part type from search_parts, such as \"servo\" or \"hcsr04\"."
}
}
}
Project format
get_project_format
How to write a Mokxi project (board, parts, wires as "partId.pin" pairs, code), with the rules, the common parts and boards with their pins, and a complete example.
Schema valid · SHA-256 b5d18ec11d6d…
View input schema
{
"type": "object",
"properties": {}
}
List boards
list_boards
The microcontroller boards Mokxi simulates, all 45 of them, or only one family's, with each board's type for the "board" field, the code it takes, its pin names, its page on mokxi.com and Mokxi's own picture of it. The optional "family" narrows the list to one family or kind of board ("ESP32", "Arduino", "Raspberry Pi"). Returns the count and the boards.
Schema valid · SHA-256 a18d33bead73…
View input schema
{
"type": "object",
"properties": {
"family": {
"type": "string",
"description": "Optional. A board family, name or type to narrow the list to, such as \"esp32\", \"arduino\", \"raspberry pi\", \"stm32\" or \"rp2040\". Left out, every board."
}
}
}
Search parts
search_parts
Find Mokxi parts by what they are ("temperature sensor", "oled", "motor driver"). Returns each part's type, pins and settings, from the simulator's own catalog, with Mokxi's own picture of the part where mokxi.com has one.
Schema valid · SHA-256 1229c5f54c1b…
View input schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "A few words: what the part is or does, or its chip name."
},
"limit": {
"type": "number",
"description": "How many to return, 1 to 30. 10 by default."
}
},
"required": [
"query"
]
}
Check a project
validate_project
Check a project the way the Mokxi editor does: every unknown part, wrong pin, bad setting and code problem, in plain words naming the part and pin. Returns whether the project is valid, its errors and warnings, and a summary of what it builds.
Schema valid · SHA-256 75157dbc0669…
View input schema
{
"type": "object",
"properties": {
"project": {
"type": "object",
"description": "A project in the Mokxi AI format: {\"format\": \"mokxi-ai/1\", \"name\": \"...\", \"board\": \"uno\", \"parts\": [{\"id\": \"led1\", \"type\": \"led\"}], \"wires\": [[\"board.13\", \"led1.A\"]], \"code\": {\"sketch.ino\": \"...\"}}. get_project_format has the full rules.",
"properties": {
"format": {
"type": "string",
"const": "mokxi-ai/1"
},
"name": {
"type": "string"
},
"board": {
"type": [
"string",
"null"
],
"description": "A board type from list_boards, such as \"uno\", \"esp32\" or \"pico\"; null for a circuit with no board."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"props": {
"type": "object"
}
},
"required": [
"id",
"type"
]
}
},
"wires": {
"type": "array",
"description": "Pairs of ends, \"partId.pin\"; the board is \"board\". A third item may name a color.",
"items": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 2,
"maxItems": 3
}
},
"code": {
"type": "object",
"description": "File name to its text: {\"sketch.ino\": \"...\"} or {\"main.py\": \"...\"}."
}
},
"required": [
"board"
]
}
},
"required": [
"project"
]
}