API reference
App backend methods
Section titled “App backend methods”appApiOperations(bindingName, api) projects a decoded App Release API into
operations such as PRINTS.generate, called as env.PRINTS.generate(); a
dotted method desktop.arrange is env.TOURTOIS.desktop.arrange(). The App
author generates that API through Agar during the build; Forage uses the same
declaration instead of a second method list. The host supplies the
installation’s binding name and can project the same API under an explicit role
alias.
appMethodSchemas(api) supplies the same converted input and output schemas,
with the declared description, effect and requirements, to execution owners.
appToolSchemas(api) uses the same converter after excluding methods marked
hidden: true. appApiOperations and host Agent/MCP discovery share this
filtered projection. appMethodSchemas keeps every declared method for direct
RPC validators. Converting a declaration grants no authority to execute it.
Each visible method is searchable and has input and output types in describe.
Describing PRINTS returns the callable nested env declaration with
asynchronous methods. The projection includes declared effects and capability
requirements as discovery notes. It supplies no execution handler or permission
grant.
The generated-declaration round trip and nested descriptions are exercised by
Hub’s app-api-discovery test.
See the generated Forage API reference. It covers
Forage.createCatalog, the createCatalog function, operation definitions, and
the search and description result types.
Modules
Section titled “Modules”| Module |
|---|
| index |
| json-schema-subset |
| openapi |