Skip to content

Interface and reference guide ​

Look up domain operations, fields, permissions, and failure handling here. Choose a page by the question you need to answer; you do not need to read this section in order.

To learn the product by using it, follow the quickstart. To understand why its data and interfaces work this way, start with Understand Clumsies and continue to the architecture and data model.

Find the right page ​

Your questionRead
Which domain owns this capability, and which interface should I call?Domain interfaces
What do the HTTP requests look like? Which version or ETag do I send?HTTP contracts and examples
How does an Agent discover, load and propose Memory?MCP: the Memory tool
How do login, roles, token refresh and local credentials work?Authentication and sessions
What does a project-specific term mean?Glossary
Which local files does Clumsies write?Runtime surfaces
How do Coding Agent hosts start the local integration?Agent adapters
Where does the implementation live?Codebase map

Machine-readable HTTP contracts ​

ContractIntended caller
Public OpenAPIAuthenticated product clients, normally daemon
Admin OpenAPIOrganization Administration; also describes health and first-installation setup

The OpenAPI route inventory is checked against Server. Some declared pagination and conditional-read behavior is ahead of the current handlers; see contract limits before building an integration. Local XPC and MCP use their own executable contracts rather than these HTTP schemas.