The manifest
manifest.json names the module, the kind of record it finds, its schedule, its secrets, the hosts it may reach and the time a run may take.
manifest.json stands at the root of the module. Tommos reads it first and refuses a module whose manifest does not
match its schema (check a).
{
"manifest_version": 1,
"name": "fictional-tenders",
"title": "Fictional tenders (an example)",
"about": "The open notices of a fictional register, a small file kept in the reference module itself.",
"kind": "bid",
"contract": { "version": 1 },
"entry": "find.ts",
"sdk": { "version": "0.2.0" },
"schedule": { "every_minutes": 1440 },
"secrets": [],
"hosts": ["raw.githubusercontent.com"],
"time_limit_seconds": 60,
"record_sources": ["fictional-register"],
"max_model_calls_per_run": 0
}The fields
| Field | Required | What it holds |
|---|---|---|
manifest_version | yes | Always 1 |
name | yes | The module's id: lower case letters, digits and dashes, 2 to 63 characters. A module with the same name in a workspace is a new version of it |
title | yes | The name a person reads in Settings, Scouts, at most 120 characters |
about | no | One or two sentences: what the module finds |
kind | yes | bid or prospect |
contract.version | yes | The version of the contract of the kind: 1 |
entry | yes | find.ts, find.mjs, find.js or find.py |
sdk.version | yes | The version of the tools the module takes. It must be the version your package.json or requirements.txt asks for |
schedule.every_minutes | yes | The default schedule: 60 to 10080. The owner sets the real one in Settings |
secrets | yes | Each secret the module needs: { "name": "THE_TOKEN", "about": "The API token of the source" }. Names are upper case and never start with TOMMOS_. Use [] for none |
hosts | yes | Each host the module may reach, 1 to 20: api.example.com, or *.example.com for its subdomains |
time_limit_seconds | yes | How long one run may take: 10 to 200 (the run, its sandbox and the work after it fit one call of Tommos) |
record_sources | for a bid | The source each of its bids carries, 1 to 10. A bid with another source is refused. A source Tommos keeps itself (highergov), or one another module of the workspace names, is refused: a module writes only under a source of its own |
max_model_calls_per_run | no | The most calls of the tool ask one run may make, 0 to 100. Leave it out when the module asks no model |
facts | no | For a prospect, the facts its records carry, at most six: { "key": "round", "label": "Round", "kind": "text" }. See Facts. A bid module names none |
Facts
A fact is a value your source states about a company, such as the round it raised and the amount. You name each fact once in the manifest, and each record gives a value for each fact it knows.
"facts": [
{ "key": "round", "label": "Round", "kind": "text" },
{ "key": "amount", "label": "Amount raised", "kind": "money" }
]| Part | What it holds |
|---|---|
key | The name a record uses: lower case letters, digits and _, a letter first, at most 40 characters |
label | The name a person reads on the screen, such as Amount raised |
kind | text, money, count or date. The contracts show the value of each kind |
A manifest names at most six facts, and each key once. Their order is the order the screens show them: a card on the board Prospecting shows the first two, and the company's page shows all of them.
A new version of the module may add a fact or leave one out. It may not change the kind of a fact the running version names: Tommos refuses that version (check a). For a new kind, name a new fact.
Hosts
A run reaches only the hosts the manifest names. The sandbox's firewall allows those domains and no other; the tools'
fetch refuses any other host before it calls, so your module hears why. A host of a model provider is refused
(check j): a module asks a model only through ask.
Secrets
The owner fills each secret in Settings, Scouts. Tommos keeps it encrypted, and the screen shows only its last four characters. Your module reads it from the environment, by its name. Tommos takes the value of every secret out of your log lines and errors before it keeps them. A secret that is a key of a model is refused (check k).
const token = process.env.THE_TOKEN;