Tools reference
Every MCP tool with its parameters, access and an example.
Generated from the tool definitions the server registers, so names, descriptions and parameters here are exactly what your agent sees. Access levels are explained in Authentication.
Registry
Public reads: industries, schemas, search, the glossary and constructs. No key needed.
- list_industriesIndustries with a published schema (the standard architecture companies are mapped against).Public
- get_schemaThe full schema of an industry: primitives grouped by part of the business, with layer, parameters, modules and connection types.Public
- searchSearch System Atlas: registry companies (name, domain, industry, coverage, claimed), industries and segments, primitives of published schemas, constructs and glossary terms; with a key also your workspaces, companies and components. Typo-tolerant and ranked. Filters can be written in the query (industry:staffing region:US layer:software type:company,primitive claimed:yes) or passed as parameters.Public
- get_glossaryThe System Atlas ontology: every term (layers, primitives, components, evidence, visibility tiers, coverage, constraints, views) with definitions.Public
- list_constructsConstructs: proven patterns that recur across many registry companies, with the primitives every instance shares (invariants), what differs (variants), support and the industries they span. Public.Public
- get_constructOne construct in full: the invariant chain, variants, couplings, flows, entropy hot spots, spread across industries and sizes, and the instance companies with their registry refs. Public.Public
- contributeOffer facts about a company you do not own (by registry ref), each with a source URL and a quote copied from that page. Each item is scored for trust: the source loads, is not fake, parked or a look-alike, contains the quote and relates to the company; it agrees with known data; your record; how specific it is. 75+ appears on the public profile as a draft the company can reject; lower scores wait for the company (or an admin). Returns each score with reasons. Needs a key.Write · editor key
- propose_primitivePropose a primitive the industry's schema does not have yet: something you found that companies in the industry run and no primitive covers. Sources are required: public web pages, each with words copied exactly from the page; at least one quote must be found on its page. Proposals are reviewed by the System Atlas team (promoted into the next version, merged into an existing primitive, or rejected); one seen at 3 or more companies is ready to promote. Needs a key.Write · editor key
Workspaces
Read the workspaces your key can reach: companies, atlases and comparisons.
- list_workspacesResearch workspaces the API key can access. Needs a key.Needs a key
- get_workspaceA workspace at a glance: its companies, how much of each is mapped, the client's layer health and top gaps. Needs a key.Needs a key
- get_company_atlasOne company's atlas: components per primitive with values, confidence and sources, the edges between them, and notes. Set public_only to see what an outsider sees. Needs a key.Needs a key
- compareThe client against competitors, one row per primitive, biggest differences first. Needs a key.Needs a key
- list_draftsDrafts waiting for review in a workspace: research findings and agent uploads not yet confirmed, each with part, primitive, evidence quote, source, origin (research run, agent key, person, contribution) and its draft values; plus contributions from outside (with a trust score) that this key may decide on. 50 a page. Needs a key.Needs a key
- review_draftsDecide on drafts by id (component ids act on the component and its draft values; value ids on one value; contribution ids accept or reject a contribution). confirm keeps it, reject removes it, private keeps it for this workspace only (off every public page). Ids the key cannot see are skipped. Needs an editor key; contributions need the company owner's key.Write · editor key
- optimal_engine_sendSend the workspace's company maps (components with values, flows, sources, confidence, provenance) to its connected cloud Optimal Engine. Each item becomes engine evidence plus a pending claim for review. Fails with 409 for a local engine: use optimal_engine_export then. Needs an editor key.Write · editor key
- optimal_engine_pullImport the connected cloud Optimal Engine's facts (promoted claims; pending ones too with include_pending) about a company into the workspace as private drafts with provenance optimal_engine, each sourced to its claim on the engine. Fails with 409 for a local engine: use optimal_engine_import then. Needs an editor key.Write · editor key
- optimal_engine_exportFor an Optimal Engine you run locally: the documents to POST, one by one, to <engine>/api/ingest with your engine key. Returns { engine, ingestPath, documents, truncated }. Needs an editor key.Write · editor key
- optimal_engine_importFor an Optimal Engine you run locally: pass the claims array from GET <engine>/api/memory-core/claim-review?workspace=<engine workspace>&lifecycle_state=promoted (up to 1000). Claims about the company land as drafts with provenance optimal_engine; others, rejected ones and this workspace's own sends are skipped. Needs an editor key.Write · editor key
Research
Add competitors and run the research agent on them.
- add_companyAdd a competitor to a workspace, with its website, so it can be researched. Needs a key.Needs a key
- research_companyStart the research agent on a company: it reads the public website and maps the company onto the schema with sources and confidence. Returns a run id; poll get_research. Needs a key.Needs a key
- get_researchProgress and result of a research run. Needs a key.Needs a key
Upload your company
Create your private workspace and upload what your agent finds.
- create_my_workspaceCreate (or find, by company name) the key owner's private workspace for their own company, classified into an industry and business model. Idempotent. Call this first, then get_mapping_guide.Write · editor key
- get_mapping_guideThe upload contract for a company: parts of the business -> primitives (key, label, layer, description) -> parameters (key, type, unit, options), connection and flow types, and instructions for describing what you find. Needs a key.Needs a key
- upload_componentsUpload up to 200 components of the company (teams, roles, tools, processes, datasets, rules, outside parties). Each is placed on a primitive (given, existing, matched, model or custom) and stored private, self-reported, draft. Re-uploading a clientId updates it. Returns per-item placement and a coverage summary. Needs an editor key.Write · editor key
- upload_flowsUpload hand-offs between components (from/to by component id, clientId or label) with a flow type. Re-uploading the same flow updates it. Needs an editor key.Write · editor key
- upload_notesUpload notes on the company or a component: comments, or the operating reality (workaround, informal_channel, bottleneck, dependency, tacit_rule, manual_handoff). Duplicates are skipped. Needs an editor key.Write · editor key
- upload_screenshotUpload one screenshot of the company's software (PNG, JPEG or WebP, up to 5 MB, base64 or an https URL) with its title and the page URL. Metadata is stripped; it is linked to the matching component or interface, else left unplaced, and stored private and unverified. The same image twice is skipped. Never capture personal or customer data. Needs an editor key.Write · editor key
- list_screenshotsScreenshots of a company you can see, newest first, with tier, verified flag, the component they sit on and an image URL. Needs a key.Needs a key
Registry authoring (admin)
For the System Atlas team: write the public atlas directly. Every write is a public System Atlas record on open-web sources. Admin keys only; any other key gets 403.
- registry_guideAdmin: the contract for writing the public atlas as System Atlas records: rules (open web only, sources, confidence), call order, idempotency keys and limits; with industry, that node's baseline schema. Needs an admin key.Admin
- registry_upsert_organizationAdmin: create or update a public registry organization, one per domain (www., paths and http fold onto the same one). Sets name, industry node, region, size, business model and the profile summary, and maps it against its baseline. Needs an admin key.Admin
- registry_upsert_componentsAdmin: up to 200 public components of a registry organization, each with its open-web source and confidence, and its values. Placed on primitives like an upload; re-sending a clientId updates it. Items on private sources are refused per item. Needs an admin key.Admin
- registry_upsert_flowsAdmin: up to 200 public flows between a registry organization's components (by clientId, label or id), with flow type, confidence and an optional open-web source. The same flow again updates it. Needs an admin key.Admin
- registry_upsert_notesAdmin: up to 200 notes on a registry organization or its components: comments or the operating reality (workaround, bottleneck, manual_handoff…), each optionally citing an open-web source. Duplicates are skipped. Needs an admin key.Admin
- registry_upsert_gapsAdmin: up to 200 gaps of a registry organization: what it has that no primitive of its schema covers, by key, with an open-web source. Gaps seen across organizations are candidates for new primitives. Needs an admin key.Admin
- registry_upsert_taxonomyAdmin: up to 200 taxonomy nodes (sectors, industries, segments) by key, each under a parent key (default Universal). Creates or updates; unchanged nodes are left alone. Needs an admin key.Admin
- registry_upsert_schemaAdmin: upsert an industry's schema (its baseline): primitives with parent, layer and parameters, and connection types, by key. Changes go into a new version, published unless publish is false; sending what is already published makes no new version. Needs an admin key.Admin