Skip to content

MCP Tools Reference

VoLCA exposes 59 tools via MCP. All tools return JSON as a text content block.

ToolRequired parametersPurpose
list_databases – LCA / ACV: list loaded LCA databases (Agribalyse, ecoinvent…)
load_databasedatabaseLCA / ACV: load a configured database into memory, its declared dependencies first (cross-database links)
unload_databasedatabaseLCA / ACV: unload a database to free memory; files stay, load_database reloads it
accept_termsdatabaseLCA / ACV: record that the user accepts the terms of use a database's publisher requires before reading; until then tools reading it are refused with the terms
derive_databasedatabase, new_nameLCA / ACV: make a parent or child of a database under a new name
list_presets – LCA / ACV: this instance's classification filter presets: each a label over (system, value, mode) filters, for search_activities' classification parameters
search_activitiesdatabase, nameLCA / ACV: search activities (processes) by name, geography, product, classification or preset
search_flowsdatabase, queryLCA / ACV: search flows by name
get_activitydatabase, process_idLCA / ACV: one activity in detail: name, location, exchanges, reference product, metadata, parameters its formulas read (own and database's), input uncertainty
aggregatedatabase, process_id, scopeLCA / ACV: sum exchanges, supply-chain entries or biosphere flows with group-by filters: any 'how much X in Y' in one call, e
get_supply_chaindatabase, process_idLCA / ACV: flat list of all upstream activities (chaîne amont, filière, intrants)
get_inventorydatabase, process_idLCA / ACV: Life Cycle Inventory (LCI) of an activity's whole chain: biosphere flows (emissions, extractions) as statistics and top flows by quantity
get_impactsdatabase, process_id, method_idLCA / ACV: LCIA score of an activity for one impact category, with functional unit and top contributing flows
compute_sensitivitydatabase, process_id, method_id, perturbationsLCA / ACV: sensitivity: score relative perturbations of technosphere coefficients
get_reduced_modeldatabase, process_id, parametersLCA / ACV: an activity's scores as a function of some input parameters, to run many values outside the engine (Monte Carlo, Sobol)
get_formula_language – The formula language of parameters and exchanges: each function and operator with usage, meaning, worked example; operators by binding, loosest first; rules for numbers, names, arguments
check_formuladatabase, formulaCheck a formula where it would be written, at the database's values: among a process's parameters ('process_id'), on one of its lines ('exchange', position among exchanges), or among database parameters if no process
list_methods – LCA / ACV: loaded LCIA methods, one per impact category (climate change, acidification, eutrophication, land use, water scarcity…)
get_flow_mappingdatabase, method_idLCA / ACV: how a method's characterization factors map onto database flows, with match coverage
get_characterizationdatabase, method_idLCA / ACV: a method's characterization factors matched to database flows
explain_cfdatabase, method_id, flow_idLCA / ACV: why one elementary flow scores with its characterization factor, and which method line applied
get_flow_factorsdatabase, flow_idLCA / ACV: which impact categories count one elementary flow, with what factor, in every loaded collection (or one): 'does this emission count anywhere?' in one call; explain_cf answers one method at a time
get_contributing_flowsdatabase, process_id, method_idLCA / ACV: elementary flows (emissions, resources) weighing most in one impact category: 'which emissions drive my climate change score?'
get_contributing_activitiesdatabase, process_id, method_idLCA / ACV: upstream activities weighing most in one impact category: 'which suppliers drive my climate change score?'
get_score_contributing_flowsdatabase, process_id, collection, scoring_set, scoreLCA / ACV: elementary flows weighing most in one score of a scoring set (one number weighing a collection's indicators; list_scoring_sets): 'which emissions drive my single score?'
get_score_contributing_activitiesdatabase, process_id, collection, scoring_set, scoreLCA / ACV: upstream activities weighing most in one score of a scoring set (list_scoring_sets): 'which suppliers drive my single score?'
list_geographiesdatabaseLCA / ACV: a database's geography codes, with display names and parent regions
list_classificationsdatabaseLCA / ACV: a database's classification systems
get_path_todatabase, process_id, targetLCA / ACV: shortest supply-chain path from a process to the first upstream activity whose name matches a pattern
get_consumersdatabase, process_idLCA / ACV: every activity consuming a supplier, directly or not, as a flat list; crDepth 1 = direct consumer, 2 = consumer's consumer… Traces a raw material downstream, e
count_search_matchesdatabase, queryLCA / ACV: how many processes, products and flows one query matches in a database, one call
compare_impactsdatabase_a, process_id_a, method_id_a, database_b, process_id_b, method_id_bLCA / ACV audit: score one logical activity on two (database, method) pairs: per-category delta and per-flow drill-down
compare_activitiesdatabase, process_id, other_process_idLCA / ACV: compare two activities line by line: lines only one has, lines whose amount or unit differ
compare_databasesdatabase, other_databaseLCA / ACV: compare two loaded databases, usually two versions: activities added, removed, changed (with compare_activities' detail)
compare_method_collectionscollection, other_collectionLCA / ACV: compare two loaded method collections, usually two versions or ports of a method: per category pair, factors added, removed, changed (both values and ratio)
profile_method_collectioncollectionLCA / ACV: what each category of a loaded collection holds, without listing factors: factors per medium ('media', none for unfiled), how many written for one location and over how many locations, how many carry it at the end of the name ('Ammonia, FR'), how many zero, how many pattern or exclusion rows, and duplicates (one key, one place: a comparison cannot pair them)
score_activitydatabase, process_id, collectionLCA / ACV: an activity's full LCIA panel and every configured scoring set in one call: per-method scores, per-set scores and indicator breakdown (one entry per scoring variable), display units, 'web_url'
score_activitiesdatabase, collection, process_idsLCA / ACV: rank N activities on one scoring set, one call
list_scoring_sets – LCA / ACV: formula-based scoring sets of loaded collections, each aggregating category scores into weighted or normalized 'score' values (e
get_gap_reportdatabaseLCA / ACV: supplier gaps of a database: input demands still unsupplied after internal resolution and cross-database linking, per (product, supplier activity named, location, unit), ranked by demanding edges
get_quality_reportdatabaseLCA / ACV: soundness report of a database, staged or loaded, for those who build or repair one: structural defects a score cannot show
get_computed_quality_reportdatabaseLCA / ACV: computed checks of a LOADED database, judged against the catalogue's own norms
get_characterization_coveragedatabaseLCA / ACV: characterization coverage of a database against loaded collections, for maintainers
edit_exchangesdatabase, process_idLCA / ACV: change what one activity consumes and emits, or its name, location, description, keeping the activity: the tool that writes data
edit_activitiesdatabase, editsedit_exchanges on several activities as one change: all edits judged first, all refused if one is; database rebuilt and relinked once (most of an edit's cost when large)
supply_missing_productdatabase, product, providerGive a missing product a supplier for every activity lacking it: each unanswered input asking for this product (and naming supplier_activity, if given) moves to the provider, keeping amount, formula, comment, as edit_activities' set_suppliers would
get_database_parametersdatabaseA database's parameters, read by every process's formulas unless the process defines its own of that name: value (or formula and its value), unit, description, uncertainty
get_database_historydatabaseEvery change to a database of one's own, oldest first: when; what, in words (activities added, rewritten, deleted; exchanges edited, amounts before and after; parameters changed); author's reason, if any; the 'database' it was made on
edit_database_parametersdatabaseSet or remove a database's parameters, then restate every process reading them: a line whose formula no longer gives its amount takes the formula's value; the answer lists processes that moved
list_scenariosdatabaseA database's scenarios: name and parameter values, as {process?, name, value}
save_scenariodatabase, name, parametersSave parameter values on a database under a name, replacing what it held; the answer lists saved scenarios
drop_scenariodatabase, nameDrop a scenario saved on a database; the answer lists those left
copy_method_collectioncollection, new_nameLCA / ACV: copy a method collection under a new name, to change it
edit_method_factorscollection, opLCA / ACV: in a loaded collection of one's own (copy or upload), change, remove or add one characterization factor, or rescale or set every factor a selector reaches
edit_method_categoriescollection, opLCA / ACV: in a loaded collection of one's own (copy or upload), add, rename, re-unit or remove an impact category
edit_scoring_setscollection, op, setLCA / ACV: change scoring sets of a loaded collection of one's own (copy or upload), each named by 'set'
undo_method_editcollectionLCA / ACV: undo a change to a collection of one's own by writing its inverse as a new journal line
get_method_historycollectionLCA / ACV: a method collection's journal, one entry per change: line, when, what (category, factor, values before and after, selector and factors touched), whether it undoes another line, whether still in effect
search_method_flowscollectionLCA / ACV: flows a loaded collection characterizes, once per direction and compartment, whose name holds every word of 'q' (case aside), by name

list_databases

LCA / ACV: list loaded LCA databases (Agribalyse, ecoinvent…). Call first, before searching.

load_database

LCA / ACV: load a configured database into memory, its declared dependencies first (cross-database links). Search, score and impact tools need it loaded; list_databases names the configured ones. No effect if loaded.

ParameterTypeRequiredDescription
databasestring✓Database name

unload_database

LCA / ACV: unload a database to free memory; files stay, load_database reloads it. Refused while a loaded database depends on it: unload those first.

ParameterTypeRequiredDescription
databasestring✓Database name

accept_terms

LCA / ACV: record that the user accepts the terms of use a database's publisher requires before reading; until then tools reading it are refused with the terms. Call only after showing the user the full terms and getting their explicit agreement: never on your own initiative, never to get past the refusal for them.

ParameterTypeRequiredDescription
databasestring✓Database name

derive_database

LCA / ACV: make a parent or child of a database under a new name. Parent (parent=true): source files reread, each multi-product block kept whole, declared shares turned into prices. Child (system_model): a parent divided by a system model, TOML text naming the default property (price, dry mass, wet mass) and exceptions, each with property, reason, and processes taken by classification or activity id. Shows a study with multi-output blocks divided by a product property, not the source's shares. Source untouched; all databases usable side by side. Full load, not a copy: seconds to minutes when large. Refused: neither or both given, child of a non-parent, model that does not read, exception taking or dividing nothing, read-only instance.

ParameterTypeRequiredDescription
databasestring✓Database name
new_namestring✓Name to register the new database under. Must not already exist.
parentbooleanIf true, make a parent: the source's files read again with each block of several products kept whole. Give this or system_model, not both.
system_modelstringThe text of a system model's TOML file, to make a child of a parent. Example: name = "Agribalyse, economic" version = "1.0.0" [allocation] default = "price" [[allocation.exceptions]] key = "wet mass" reason = "..." classification = { system = "Category", value = "Agricultural\\Food\\Cheese production" } (processes = ["<activity id>", ...] instead of classification for a few processes).

list_presets

LCA / ACV: this instance's classification filter presets: each a label over (system, value, mode) filters, for search_activities' classification parameters.

search_activities

LCA / ACV: search activities (processes) by name, geography, product, classification or preset. Ranked, paginated, best first, with process IDs. Activity and product names together must hold every word, or a close spelling. Entry point for any product or process question, any language: food (yaourt, steak, pain, lait, fromage), packaging (PET, verre, carton), matériaux, énergie, transport, empreinte carbone, empreinte environnementale, impact environnemental, occupation des sols, surface agricole, prairie, pâturage, intrants, filière, chaîne amont. Names are mostly English: translate into their language first (pomme de terre: potato, acier: steel). Nothing fits: try the database's own wording, or a broader word.

ParameterTypeRequiredDescription
classificationstringClassification system (e.g. 'ISIC rev.4 ecoinvent', 'CPC'; list_classifications).
classification_matchstringMatch mode: "equals" (case-insensitive equality) or "contains" (substring, default)
classification_valuestringValue within the classification system to match
databasestring✓Database name
exactbooleanTrue: the name equals (case aside) instead of containing, and geo is that location alone, not the ones inside it
geostringLocation (e.g. 'FR', 'DE', 'GLO') and every location inside it ('US' matches 'US-WECC', 'RER' matches 'FR'), per the engine's location table, never the spelling: 'GL' does not match 'GLO'.
limitintegerMax results (default 20)
namestring✓Words in the language of the database's names (usually English), or the exact name with exact=true. A source file's dataset identifier (SimaPro 'Process identifier'), whole or its four or more distinguishing characters, puts that dataset's products first.
presetstringClassification preset (list_presets), expanded to its filters; combines with explicit classification filters.
processstring[]Process IDs (activityUUID_productUUID) to list instead of searching, in the order given, through the geo, product, exact and classification filters; name and sort ignored. An ID not held is left out; a malformed one, or a bare activity UUID naming several processes, is refused.
productstringProduct name filter

search_flows

LCA / ACV: search flows by name. 'kind': biosphere (substance exchanged with nature: CO2, CH4, water, land occupation), technosphere (product one activity makes, another consumes) or waste. kind=biosphere keeps substances only, what factor and inventory questions want. Biosphere 'category' is the medium (air, water, soil, resource): resource taken vs emission released; other kinds have none.

ParameterTypeRequiredDescription
databasestring✓Database name
kindstringKeep only these kinds of flow: technosphere | biosphere | waste. Name several separated by commas, as in "biosphere,waste". Omit for all three.
limitintegerMax results (default 20)
querystring✓Flow name to search for

get_activity

LCA / ACV: one activity in detail: name, location, exchanges, reference product, metadata, parameters its formulas read (own and database's), input uncertainty. exchange_type / is_input / flow filter exchanges. Metadata (description, documentation, source) comes with every filter; without hundreds of exchanges: exchange_type=technosphere, is_input=false.

ParameterTypeRequiredDescription
databasestring✓Database name
exchange_typestring"technosphere" (products, inputs), "biosphere" (emissions, resources), "waste" (residuals sent to treatment) or "all" (default)
flowstringFlow name or synonym, read as search_flows does: every word, case-blind, any order, punctuation optional
is_inputbooleanTrue: inputs only; false: outputs only; omitted: both. Combines with exchange_type.
process_idstring✓Process ID (activityUUID_productUUID format)

aggregate

LCA / ACV: sum exchanges, supply-chain entries or biosphere flows with group-by filters: any 'how much X in Y' in one call, e.g. 'combien de surface agricole / d'eau / d'énergie dans un produit ?' via scope=biosphere or scope=supply_chain. Examples: - Electricity in direct inputs: scope=direct, is_input=true, filter_name=Electricity, filter_unit=kWh - Mass breakdown of direct inputs: scope=direct, is_input=true, filter_unit=kg, group_by=name - Energy across the supply chain: scope=supply_chain, max_depth=2, filter_classification=["Category type=energy:exact"] - Largest pasture occupation flow: scope=biosphere, filter_name=Occupation, pasture, group_by=name - Upstream electricity without double counting: scope=consumption, filter_name=electricity, filter_consumer_not=electricity - Grass eaten by cattle over the chain: scope=consumption, filter_name=grass, filter_consumer=cattle scope=supply_chain rows are cumulative productions: a filtered product feeding another (electricity high→medium→low voltage) counts twice. scope=consumption: one row per scaled technosphere edge (product, supplier, consumer), so sums are real consumption; gross throughput by default, filter_consumer_not drops edges inside the family. Byproduct edges stay negative. filter_classification: "System=Value[:exact]" (default contains). Inputs no loaded database supplies count as zero, in 'cutoffInputs'; 'withheldCutoffs' counts those a licence hides.

ParameterTypeRequiredDescription
aggregatestringsum_quantity | count | share (default: sum_quantity)
databasestring✓Database name
filter_classificationstring[]List of "System=Value[:exact]" strings; defaults to 'contains' mode
filter_consumerstringOnly for scope=consumption: case-insensitive substring on the consuming activity's name
filter_consumer_notstringOnly for scope=consumption: comma-separated consumer-name exclude list (each item is a substring; a name containing a comma cannot be expressed)
filter_is_referencebooleanFilter by reference-product flag (typically for outputs)
filter_namestringCase-insensitive substring on flow/activity name
filter_name_notstringComma-separated substring exclude list
filter_target_namestringOnly for scope=direct technosphere or scope=consumption: filter by supplier activity name
filter_unitstringWhole unit name, case-insensitive: "MJ" and "mj" are the same unit, "kg" does not match "kgm"
group_bystringname | flow_id | name_prefix | unit | classification.<system> | location | target_name | consumer_name
is_inputbooleanOnly for scope=direct: true=inputs only, false=outputs only
max_depthintegerOnly for scope=supply_chain: max hops from the root activity
presetstringName of a classification preset (from list_presets): expanded and merged into filter_classification.
process_idstring✓Process ID (activityUUID_productUUID format)
scopestring✓direct | supply_chain | biosphere | consumption

get_supply_chain

LCA / ACV: flat list of all upstream activities (chaîne amont, filière, intrants). 'quantity': cumulative amount per functional unit (scaling_factor × root reference amount); step yield = supplier's scaling_factor ÷ consumer's. Summing entries feeding each other (electricity high→medium→low voltage) counts twice: use aggregate scope=consumption for totals. 'unit' is the producer's reference unit, which SimaPro and Brightway Excel imports write in the dimension's canonical unit (kg, mj, m3), so may differ from the consuming line's: 0.22 kWh shows in mj (1 kWh = 3.6 MJ). Read it off the entry. Inputs no loaded database supplies count as zero, in 'cutoffInputs'; 'withheldCutoffs' counts those a licence hides.

ParameterTypeRequiredDescription
classificationstringClassification system name (e.g. 'Category', 'Category type')
classification_matchstringMatch mode: "exact" (case-insensitive equality) or "contains" (substring, default)
classification_valuestringValue within the classification system
databasestring✓Database name
limitintegerMax results (default 100)
locationstringFilter by geography/location: that location, plus every location inside it ('US' also matches 'US-WECC'), case-insensitive
max_depthintegerMax depth from root (1 = direct inputs only)
min_quantitynumberMin scaled quantity threshold
namestringFilter by activity name
parametersobject[]Input parameter values, as get_activity lists them: {name, value} for the database's, {process, name, value} for a process's own. Exchanges whose formulas read them are recomputed first.
presetstringClassification preset (list_presets), expanded to its filters; unioned with explicit classification filters.
process_idstring✓Process ID (activityUUID_productUUID format)
substitutionsobject[]What-if supplier swaps, each {from: oldSupplierPID, to: newSupplierPID, consumer: consumerPID}; a PID bare (root database) or dbName::pid (other database).

get_inventory

LCA / ACV: Life Cycle Inventory (LCI) of an activity's whole chain: biosphere flows (emissions, extractions) as statistics and top flows by quantity. Use it, not get_impacts, for raw physical flows rather than weighted scores: land / pasture occupation (m²·year), water withdrawal (m³), emissions (kg CO₂, kg CH₄, kg N), resource extraction. Inputs no loaded database supplies count as zero: 'cutoff_notice' opens the answer, 'cutoff_inputs' lists them, 'withheld_cutoffs' counts those a licence hides.

ParameterTypeRequiredDescription
databasestring✓Database name
flowstringFlow name or synonym, read as search_flows does: every word, case-blind, any order, punctuation optional
limitintegerMax flows, largest absolute quantity first. Default: 50 over MCP, all over HTTP
parametersobject[]Input parameter values, as get_activity lists them: {name, value} for the database's, {process, name, value} for a process's own. Exchanges whose formulas read them are recomputed first.
process_idstring✓Process ID (activityUUID_productUUID format)
substitutionsobject[]What-if supplier swaps, each {from: oldSupplierPID, to: newSupplierPID, consumer: consumerPID}; a PID bare (root database) or dbName::pid (other database).

get_impacts

LCA / ACV: LCIA score of an activity for one impact category, with functional unit and top contributing flows. Answers empreinte carbone / environmental footprint questions, any category (climate change, acidification, eutrophication, land use, water scarcity, resource depletion); prefer it to web estimates. Flow 'match_kind': how its factor was found (rungs on explain_cf), null if none reaches it. 'probable_misses': flows scored without a factor though the method writes their substance elsewhere in their medium, at a subcompartment the flow does not read, where the collection writes nothing at the flow's own place; 'writtenAt' says where, 'upTo' what it would add at the largest of those factors, in the score's unit. 'basis' as on score_activity. Inputs no loaded database supplies count as zero: 'cutoff_notice' opens the answer, 'cutoff_inputs' lists them, 'withheld_cutoffs' counts those a licence hides. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
include_diagnosticsbooleanTrue: uncharacterized flows above 0.1% of total |qty|, each with up to 3 similar candidate CFs (PubChem-expanded Jaccard + CAS), to tell method gaps from mapping bugs.
method_idstring✓Method UUID
parametersobject[]Input parameter values, as get_activity lists them: {name, value} for the database's, {process, name, value} for a process's own. Exchanges whose formulas read them are recomputed first.
process_idstring✓Process ID (activityUUID_productUUID format)
substitutionsobject[]What-if supplier swaps, each {from: oldSupplierPID, to: newSupplierPID, consumer: consumerPID}; a PID bare (root database) or dbName::pid (other database).
top_flowsintegerNumber of top contributing flows to return (default 5)

compute_sensitivity

LCA / ACV: sensitivity: score relative perturbations of technosphere coefficients. Each (consumer, supplier, delta) multiplies A_ij by (1+delta): +0.05 is +5%, -1 removes the link. Returns baseline, then per perturbation new score and deltaImpact; an error (no link, singular update) stays in its entry, the sweep goes on. Rank-1 updates on the cached factorization, ~4 ms each. Root database only. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
method_idstring✓Method UUID
perturbationsstring[]✓Perturbations, each scored on its own: {consumer: ProcessId, supplier: ProcessId, delta: number, label?: string}. delta is RELATIVE: A_ij × (1+delta); +0.05 for +5%, -1 removes the link. Both processes in the root database. label is echoed back.
process_idstring✓Process ID (activityUUID_productUUID format)

get_reduced_model

LCA / ACV: an activity's scores as a function of some input parameters, to run many values outside the engine (Monte Carlo, Sobol). Parameters as get_activity lists them: {name} for the database's, {process, name} for a process's own. Per method of the collection: score at the database's values ('baseline'); processes these parameters move, with exchanges as formula trees, stored amounts, emission factors; suppliers' unit scores and the scaling each gives the moving processes; scoring sets as formulas over category totals. Refused when a parameter moves an allocation share, or more than 500 processes.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
parametersobject[]✓The input parameters the model is a function of, as get_activity lists them. Each entry: {name} for a parameter of the database, {process, name} for a process's own.
process_idstring✓Process ID (activityUUID_productUUID format)

get_formula_language

The formula language of parameters and exchanges: each function and operator with usage, meaning, worked example; operators by binding, loosest first; rules for numbers, names, arguments.

check_formula

Check a formula where it would be written, at the database's values: among a process's parameters ('process_id'), on one of its lines ('exchange', position among exchanges), or among database parameters if no process. Answers value and names read, or the problem: name without value, cycle, formula that does not read. On a line, one parameter (or a number times one) whose unit does not convert to the line's is warned; products and quotients of units are not judged.

ParameterTypeRequiredDescription
databasestring✓Database name
exchangeintegerThe line the formula would be written on, by its position among the process's exchanges as get_activity lists them
formulastring✓The formula, in VoLCA's language (get_formula_language)
process_idstringThe process whose parameters and named lines the formula reads; the database's parameters alone when absent

list_methods

LCA / ACV: loaded LCIA methods, one per impact category (climate change, acidification, eutrophication, land use, water scarcity…).

get_flow_mapping

LCA / ACV: how a method's characterization factors map onto database flows, with match coverage.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
max_unmatchedintegerCap on each unmatched list (default 50)
method_idstring✓Method UUID
process_idstringRanks unmatched_db_flows by their share of this process's inventory.
verbosebooleanTrue: beyond coverage stats, unmatched_cfs (CFs with no database flow) and unmatched_db_flows (ranked when process_id is set).

get_characterization

LCA / ACV: a method's characterization factors matched to database flows. No 'flow': top factors by absolute value; with it, a name search. Gives CF value, direction, matched flow, match strategy.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
flowstringFilter by flow name (case-insensitive substring, matches both method CF name and database flow name)
limitintegerMax results (default 20)
method_idstring✓Method UUID

explain_cf

LCA / ACV: why one elementary flow scores with its characterization factor, and which method line applied. Relay the 'explanation' sentences as written; do not decode the codes yourself. 'outcome': characterized, conversion_refused (factor found, unit does not convert: scores nothing) or no_factor. 'match.rung', how the factor was found: flow_id (flow named by the method), same_unit_name (line in the flow's unit), exact_name (name and compartment), compartment_default (the compartment's line), if_absent (subcompartment without line, sent to another by the compartment table), resource_unspecified (resource read at its name's unspecified line), cas_number (same CAS), region_base_name (base substance, region suffix untagged by the method), energy_content (charge per energy, or the carrier family's factor over its energy content, applied to the content the name states), ore_base_element (graded ore's base element). 'steps_tried': rungs tried before. 'match.unitConversion': same_unit, unknown_unit (unit not in the table, amount kept), unit_converted, normalized_to_base_unit (factor written as 'kg CO2 eq'-like expression, amount brought to base unit), energy_content (across dimensions by energy density). 'match.refusal': different_dimensions, no_base_unit, energy_bridge_failed. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
flow_idstring✓Database flow UUID, as returned by search_flows or in the flow_id field of get_contributing_flows
method_idstring✓Method UUID

get_flow_factors

LCA / ACV: which impact categories count one elementary flow, with what factor, in every loaded collection (or one): 'does this emission count anywhere?' in one call; explain_cf answers one method at a time. Per collection, 'factors' lists methods with something to say, shaped as explain_cf answers (relay 'explanation'). 'outcome': characterized, conversion_refused (factor unusable: scores nothing), or no_factor with 'regionalFactorCount' > 0: charged by the emitting activity's location, so it counts though no single factor answers. 'noFactor': methods giving no factor anywhere. All 'factors' empty: the flow adds nothing to any score, whatever its amount. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstringMethod collection name (from list_methods) to ask alone; every loaded collection when omitted
databasestring✓Database name
flow_idstring✓Database flow UUID, as returned by search_flows or in the flow_id field of get_contributing_flows

get_contributing_flows

LCA / ACV: elementary flows (emissions, resources) weighing most in one impact category: 'which emissions drive my climate change score?'. Flow 'match_kind': how its factor was found (rungs on explain_cf), null if none reaches it. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
include_diagnosticsbooleanTrue: uncharacterized flows above 0.1% of total |qty|, each with up to 3 similar candidate CFs (PubChem-expanded Jaccard + CAS).
limitintegerMax flows to return, sorted by contribution (default 20)
method_idstring✓Method UUID for the impact category
process_idstring✓Process ID (activityUUID_productUUID format)

get_contributing_activities

LCA / ACV: upstream activities weighing most in one impact category: 'which suppliers drive my climate change score?'. Exact matrix computation, valid for cyclic chains. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstringMethod collection (list_methods). Only when the method UUID is loaded in several collections (e.g. two EF 3.1 versions); an ambiguous UUID fails listing them.
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
limitintegerMax processes to return, sorted by contribution (default 10)
method_idstring✓Method UUID for the impact category
process_idstring✓Process ID (activityUUID_productUUID format)

get_score_contributing_flows

LCA / ACV: elementary flows weighing most in one score of a scoring set (one number weighing a collection's indicators; list_scoring_sets): 'which emissions drive my single score?'. Contribution = weighted sum over indicators, so flows add up to score_activity's score. 'cf_value': what one unit of the flow adds. A score that is not a weighted sum of indicators has no split: refused. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstring✓Method collection name the scoring set is configured on (from list_scoring_sets)
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
limitintegerMax flows to return, sorted by contribution (default 20)
process_idstring✓Process ID (activityUUID_productUUID format)
scorestring✓Name of one score of that scoring set (from list_scoring_sets)
scoring_setstring✓Scoring set name (from list_scoring_sets)

get_score_contributing_activities

LCA / ACV: upstream activities weighing most in one score of a scoring set (list_scoring_sets): 'which suppliers drive my single score?'. Contribution = weighted sum over indicators, so activities add up to score_activity's score. A score that is not a weighted sum of indicators has no split: refused. 'basis' as on score_activity. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstring✓Method collection name the scoring set is configured on (from list_scoring_sets)
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
limitintegerMax processes to return, sorted by contribution (default 10)
process_idstring✓Process ID (activityUUID_productUUID format)
scorestring✓Name of one score of that scoring set (from list_scoring_sets)
scoring_setstring✓Scoring set name (from list_scoring_sets)

list_geographies

LCA / ACV: a database's geography codes, with display names and parent regions. 'geo' is search_activities' geography filter.

ParameterTypeRequiredDescription
databasestring✓Database name

list_classifications

LCA / ACV: a database's classification systems. No 'system': names and activity counts only. With it: all its values, 'filter' narrowing by substring.

ParameterTypeRequiredDescription
databasestring✓Database name
filterstringSubstring filter applied to values when a system is specified (case-insensitive).
systemstringClassification system name to inspect (e.g. 'ISIC rev.4 ecoinvent'). If omitted, returns only system names and counts.

get_path_to

LCA / ACV: shortest supply-chain path from a process to the first upstream activity whose name matches a pattern. Each step: cumulative_quantity, scaling_factor, local_step_ratio (upstream ÷ downstream scaling factor); total_ratio, their product, is the end-to-end conversion factor.

ParameterTypeRequiredDescription
databasestring✓Database name
process_idstring✓Process ID (activityUUID_productUUID format)
targetstring✓Case-insensitive name substring to stop at

get_consumers

LCA / ACV: every activity consuming a supplier, directly or not, as a flat list; crDepth 1 = direct consumer, 2 = consumer's consumer… Traces a raw material downstream, e.g. processed foods made with one ingredient.

ParameterTypeRequiredDescription
classificationstringClassification system name (e.g. 'ISIC rev.4 ecoinvent')
classification_valuestringClassification value substring to match
databasestring✓Database name
include_edgesbooleanTrue: also every technosphere edge between activities reachable from the supplier, to rebuild supplier→consumer paths without get_path_to.
limitintegerMax results (default 1000)
locationstringFilter by geography/location (e.g. 'FR', 'DE'): that location, plus every location inside it ('RER' also matches 'FR'), case-insensitive
max_depthintegerMax hops from supplier (1 = direct consumers only)
namestringFilter by name (case-insensitive substring)
presetstringName of a classification preset (from list_presets): expands to its bundled filters
process_idstring✓Process ID of the supplier (activityUUID_productUUID format)
productstringFilter by product name (case-insensitive substring)

count_search_matches

LCA / ACV: how many processes, products and flows one query matches in a database, one call. Disjoint, together the whole database: process = activity row (searched, read, scored), product = technosphere flow one activity makes and another consumes, flow = exchanged with nature or discarded. Tells what a query is about before listing: 2 processes and 300 flows is a substance, not a product.

ParameterTypeRequiredDescription
databasestring✓Database name
querystring✓The search term to count matches for

compare_impacts

LCA / ACV audit: score one logical activity on two (database, method) pairs: per-category delta and per-flow drill-down. For cross-database mapping audits, e.g. BAFU + EF3.1 vs SimaPro + EF3.1: flows diverging from mapping gaps, not chemistry. Headline delta.relative_pct, driven down by synonym pairs in data/flows.csv or a regenerated chem_synonyms snapshot. Each side carries 'probable_misses' (see get_impacts) and 'basis' (see score_activity).

ParameterTypeRequiredDescription
collection_astringMethod collection for the A side; needed only when method_id_a is loaded in more than one collection.
collection_bstringMethod collection for the B side; needed only when method_id_b is loaded in more than one collection.
database_astring✓First database name
database_bstring✓Second database name
method_id_astring✓Method UUID for the A side
method_id_bstring✓Method UUID for the B side
process_id_astring✓Process ID in database_a (activityUUID_productUUID format)
process_id_bstring✓Process ID in database_b (activityUUID_productUUID format)
top_flowsintegerPer-side flow drill-down depth (default 10)

compare_activities

LCA / ACV: compare two activities line by line: lines only one has, lines whose amount or unit differ. Other activity may be in another loaded database (other_database): adapted copy vs original. Lines pair on flow id and role, then flow name (case, trailing ' {GEO}' and SimaPro's ' U'/' S' aside), compartment and role; 'match' says which ('SameFlow', 'SameFlowName'). Role is part of a line: input turned coproduct = one removed, one added. One flow's lines in one unit are summed; one line each side with another supplier = 'SupplierChanged' (each by activity name and location); several suppliers compare totals only. A flow in several units on one side: 'uncompared'. Amounts equal within relative 1e-9; units by name. 'summary': differing activity name, location, product name, allocation share, description, stated dates; product amount by its reference line. Nothing listed: same content.

ParameterTypeRequiredDescription
databasestring✓Database name
other_databasestringLoaded database holding that activity, when it is not this one
other_process_idstring✓Process ID of the activity to compare against (activityUUID_productUUID format)
process_idstring✓Process ID (activityUUID_productUUID format)

compare_databases

LCA / ACV: compare two loaded databases, usually two versions: activities added, removed, changed (with compare_activities' detail). Pairing cascade, each rung on what earlier ones left: 'SameProcessId' (same activityUUID_productUUID), 'SameNames' (activity and product names, case, trailing ' {GEO}' and SimaPro's ' U'/' S' aside, same location), 'SameProduct' (same reference product flow, location and activity kind, so no market pairs a production), 'SameCutNames' (names over 80 characters cut with their geography, as SimaPro does). Changed activities name their rung. A key several activities share, either side, pairs none: 'ambiguous', not compared. Only stated dates differ: 'redated'; same content: 'unchanged', with rung; the three lists are all pairs. 'database' is the base, usually older. Counts cover full lists, limit truncates each: pass one in a conversation (thousands differ, 'unchanged' holds nearly all).

ParameterTypeRequiredDescription
databasestring✓Database name
limitintegerMax entries per list (added, removed, changed, redated, ambiguous, unchanged), in name order (default: all). The counts always cover the full lists.
other_databasestring✓Loaded database to compare against, usually the newer version

compare_method_collections

LCA / ACV: compare two loaded method collections, usually two versions or ports of a method: per category pair, factors added, removed, changed (both values and ratio). Categories pair on 'pairs', then 'SameMethodName', then 'SameImpactCategory', case and spacing aside; a name several share is 'ambiguous', settled by 'base=other' in 'pairs'. Factors pair per direction, compartment and location in a cascade: 'SameFlowId', 'SameName', 'SameSynonymClass', 'SameCAS' (refused when the registry keeps the names apart), 'SamePattern' for pattern and exclusion rows. Compartment-table fallbacks not followed: a precise subcompartment never equals unspecified; 'unspecified' is the whole medium. A factor without location whose name ends in a geography code ('Ammonia, FR') is read there. 'Occupation, ...' / 'Transformation, ...' under the whole natural-resource medium read in the land subcompartment, every land factor as input. 'reading': how both values were read per unit; equal within relative 1e-9. 'collection' is the base. Counts cover full lists, limit truncates each list of each category: pass one in a conversation.

ParameterTypeRequiredDescription
categorystringCompare only the pair whose base category has this name, which is much faster than comparing them all; the unpaired and ambiguous categories are still listed
collectionstring✓Base method collection, usually the older version
limitintegerMax entries per list of each category (added, removed, changed, ambiguous, unconvertible), in order (default: all). The counts always cover the full lists.
other_collectionstring✓Loaded method collection to compare against
pairsstring[]Categories to pair by hand, each written "base=other" with the two category names; taken before any other pairing

profile_method_collection

LCA / ACV: what each category of a loaded collection holds, without listing factors: factors per medium ('media', none for unfiled), how many written for one location and over how many locations, how many carry it at the end of the name ('Ammonia, FR'), how many zero, how many pattern or exclusion rows, and duplicates (one key, one place: a comparison cannot pair them). Compartments and locations read as compare_method_collections does.

ParameterTypeRequiredDescription
collectionstring✓Loaded method collection to profile

score_activity

LCA / ACV: an activity's full LCIA panel and every configured scoring set in one call: per-method scores, per-set scores and indicator breakdown (one entry per scoring variable), display units, 'web_url'. One batched solve instead of get_impacts per method. list_scoring_sets names the sets. exchange_contributions splits each score by the activity's own lines, to group into stages (ingredients, transport, packaging). Inputs no loaded database supplies count as zero, in 'cutoffInputs'; 'withheldCutoffs' counts those a licence hides. 'basis': what the score rests on (engine and commit; each database read, its release, whether copied, edited, allocated otherwise or patched; method collection, whether a modified copy; substitutions and parameter values sent). Quote it with the number: scores compare only on the same basis. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstring✓Method collection name (use list_methods to discover)
databasestring✓Database name
exchange_contributionsbooleanTrue: each method's result lists what each of the activity's lines adds ('exchangeContributions': position as get_activity numbers exchanges, contribution, share), largest first, summing to the score. Scoring-set scores not split. Not with substitutions. Empty when the licence keeps detail or inventory to itself. Default false.
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
parametersobject[]Input parameter values, as get_activity lists them: {name, value} for the database's, {process, name, value} for a process's own. Exchanges whose formulas read them are recomputed first.
process_idstring✓Process ID (activityUUID_productUUID format)
scoring_setsstring[]Scoring set names (list_scoring_sets). score_activity: keeps only these in scoringResults / scoringUnits / scoringIndicators. score_activities: the one set to rank on, one name, auto-picked when the collection has one. An unknown name fails, listing the names.
substitutionsobject[]What-if supplier swaps, each {from: oldSupplierPID, to: newSupplierPID, consumer: consumerPID}; a PID bare (root database) or dbName::pid (other database).

score_activities

LCA / ACV: rank N activities on one scoring set, one call. Columnar JSON {scoring_set, scoring_unit, functional_unit?, columns, rows, not_found, invalid, unscorable, unsolvable, cutoff_notice?, cutoff_inputs_by_process_id?, withheld_cutoffs_by_process_id?}. 'columns' heads 'rows' (one scalar array per activity): ['name', 'process_id', 'web_url', 'total', 'cutoffs', <indicator keys...>]; 'cutoffs' counts the row's chain inputs no loaded database supplies (scored zero, listed in 'cutoff_inputs_by_process_id'). 'functional_unit' top-level when all rows share it, else a column. No per-method scores: score_activity gives them. Unresolved IDs: not_found / invalid; refused allocation: unscorable; no solver answer (a loop consuming all it makes): unsolvable; one line per reason with its process_ids, the rest still ranked. 'basis' once for all (see score_activity); a row's parameter set is a position in 'parameterSets'. Set that weighs (list_scoring_sets): quote 'reading_notice' with any comparison. Collection with several sets: pass scoring_sets: ["<one>"]. 'parameter_sets': each activity scored at each set, 'parameter_set' column after 'process_id'. Show each 'web_url' as a clickable link: it opens the VoLCA page.

ParameterTypeRequiredDescription
collectionstring✓Method collection name
databasestring✓Database name
exclude_long_termbooleanTrue: score without delayed long-term (> 100 yr) emissions, as out of scope. They are never resources, so regionalized water and land are unaffected. Default false (kept, the ecoinvent/EF convention).
parameter_setsobject[][]Sets of input parameter values, each a list shaped as get_impacts' 'parameters'. Every activity is scored at each set in turn; without it, at the database's own values.
process_idsstring[]✓Process IDs to score (activityUUID_productUUID). All resolved in one multi-RHS solve.
scoring_setsstring[]Scoring set names (list_scoring_sets). score_activity: keeps only these in scoringResults / scoringUnits / scoringIndicators. score_activities: the one set to rank on, one name, auto-picked when the collection has one. An unknown name fails, listing the names.
summary_onlybooleanTrue: one 'dominant_indicator' column instead of per-indicator ones, cells {key, share_pct} (e.g. {"key": "ldu", "share_pct": 82.3}), the indicator with the largest absolute share of the row's total. For large batches before score_activity on one PID. Default false.

list_scoring_sets

LCA / ACV: formula-based scoring sets of loaded collections, each aggregating category scores into weighted or normalized 'score' values (e.g. single score plus per-area-of-protection sub-scores). Per set: name, display unit, variables (each with its category), computed intermediates, display labels (variable → indicator name), normalization and weighting factors, score formulas; the same set as 'rows' (label, categories with coefficient or formula, normalization, weight) with 'sum_of_rows', scores adding up the rows, which a new row joins. 'weighs': scores rest on value choices (a category weighed or counted otherwise than once, or normalized categories added), which ISO 14044 forbids in a comparison disclosed to the public. Set names key score_activity / score_activities answers; edit_scoring_sets changes rows by variable.

ParameterTypeRequiredDescription
collectionstringMethod collection name. If omitted, returns scoring sets across all loaded collections, grouped by collection.

get_gap_report

LCA / ACV: supplier gaps of a database: input demands still unsupplied after internal resolution and cross-database linking, per (product, supplier activity named, location, unit), ranked by demanding edges. Each gap: every blocking reason, consumer edge and distinct consumer counts, total demand, top consumers. 'What is missing to switch or complete this database's background?', typically after a relink.

ParameterTypeRequiredDescription
databasestring✓Database name
limitintegerMax gaps, biggest first (default all); header counts cover the full report.

get_quality_report

LCA / ACV: soundness report of a database, staged or loaded, for those who build or repair one: structural defects a score cannot show. Checks: reference exchange not exactly one; allocation shares not summing to 100%, on some coproducts only, or outside 0-100%; outright duplicates (name, location, reference product); non-finite amounts, zero reference amount; missing metadata (description, classification, location, unit unknown to the registry); undeclared geography, read off the name (SimaPro writes 'Unspecified' in whole databases) or filled by the loader; amounts disagreeing with their formulas, unevaluable formulas (mathematicalRelation); names merging under SimaPro's 80-character cut; exchanges missing the pedigree their database carries; reference products nothing consumes (expected for final products); unbalanced land transformation 'to'/'from' areas; impossible oxygen-demand or organic-carbon order (BOD5 > COD, dissolved > total organic carbon); failing CAS check digit. Finding: severity (danger, warning, info), activity, detail. get_gap_report answers 'what is missing?'.

ParameterTypeRequiredDescription
databasestring✓Database name
limitintegerMax findings per check, worst first (default all); offenderCount covers the full list.

get_computed_quality_report

LCA / ACV: computed checks of a LOADED database, judged against the catalogue's own norms. Scores every (activity, product) entry with one collection (the only loaded one, or 'collection'): per-category outliers on a log scale by median/MAD within (category, reference unit) groups (a mg-read-as-kg slip lands three orders out); entries scoring zero everywhere (empty or uncharacterized inventory); negative scores (info: fine where avoided-production credits or waste treatment dominate). get_quality_report checks what is STORED, staged databases too; this needs matrices and a loaded collection. Same finding shape.

ParameterTypeRequiredDescription
collectionstringMethod collection to score with; required when several are loaded.
databasestring✓Database name
limitintegerMax findings per check, worst first (default all); offenderCount covers the full list.

get_characterization_coverage

LCA / ACV: characterization coverage of a database against loaded collections, for maintainers. Lists flows a method scores ONLY through a name bridge (synonym or CAS): VoLCA scores them, a tool matching factors by exact name scores them zero, silently. Grouped under the method's own name (rename target). One entry per collection, so two versions compare side by side; optionally one collection.

ParameterTypeRequiredDescription
collectionstringOne loaded method collection (list_methods); every one when omitted.
databasestring✓Database name
limitintegerMax bridge groups per collection (default all); bridgeGroupCount covers the full list.

edit_exchanges

LCA / ACV: change what one activity consumes and emits, or its name, location, description, keeping the activity: the tool that writes data. Adapts an imported dataset to the study: drop an out-of-scope substance, fix an amount, add a missing supplier, fix name or location, give a line a formula, set or remove an activity parameter. Unnamed parts stay (classification, synonyms, pedigree, coproducts). Inventory side only: input by provider process_id, waste output by treatment process_id, biosphere line by flow id (get_activity); reference product and coproducts unreachable (they make the activity what it is). Selector matching nothing: refused; matching several lines: all edited, count given. Formulas in the engine's language (get_formula_language; check_formula tries one). After all changes, a line whose formula no longer gives its amount takes the formula's value, listed under restated. Refused on databases read from the engine's configuration (shared background): copy first. 'transient': in memory only, an unload undoes it.

ParameterTypeRequiredDescription
add_biosphereobject[]Biosphere lines to add: {direction, amount} plus flow (an existing flow id) or name + compartment + unit, reaching the flow the database declares under them, new only when none does.
add_inputsobject[]Technosphere inputs to add: {provider, amount, unit?, comment?}; the flow follows from the provider.
add_waste_outputsobject[]Waste outputs to add: {provider, amount, unit?, comment?}, provider being the treatment process.
databasestring✓Database name
notestringWhy, in a sentence. Kept in the history (get_database_history) and the export's changes report.
process_idstring✓Process ID (activityUUID_productUUID format)
removeobject[]Lines to drop, each by the selector get_activity gives: {kind, provider|flow, location?}; kind "input" or "waste" with the provider's process_id (or flow id and location for a line naming no provider), or "biosphere" with the flow id.
remove_parametersstring[]Activity parameters to remove, once the formulas set here no longer read them. Refused while a formula reads one the database does not define.
set_amountsobject[]Lines to restate: {select: {kind, provider|flow, location?}, amount}.
set_descriptionstring[]The activity's new description, one string per paragraph; [] clears it.
set_dry_massesobject[]Product dry masses, for the dry mass key: {product, dryMass}, product as in set_prices, dryMass {amount, unit} per unit of product in a mass unit, or null to remove.
set_formulasobject[]Lines to give a formula: {select: {kind, provider|flow, location?}, formula}; null drops the formula, keeping the amount.
set_locationstringThe activity's new location code (e.g. FR).
set_namestringThe activity's new name.
set_parametersobject[]Activity parameters to add, or replace whole under the same spelling (unit, description or uncertainty left out is dropped): {name} plus value (uncertainty?) or formula, unit?, description?.
set_pricesobject[]Product prices, for the price allocation key: {product, price}, product the flow id of the reference product or a coproduct, price {amount, unit} with the currency as unit, or null to remove.
set_suppliersobject[]Inputs to move to another supplier, linked or not: {select: {kind: "input", provider|flow, location?}, provider}, provider the new supplier's process_id here or in a dependency. The line keeps amount, unit, formula, comment, pedigree.
set_wet_massesobject[]Product wet masses, for the wet mass key: {product, wetMass}, as set_dry_masses. On a product in litres or cubic metres it is the density, multiplied by the line's amount, which alone cannot be weighed.
sourceobjectWhere the change's figures come from: {document, page?, passage?}: the paper or report, page counted from 1, the words relied on. Covers the whole call (one page per exchange: one call each). Kept in the history (get_database_history) and the export's changes report.

edit_activities

edit_exchanges on several activities as one change: all edits judged first, all refused if one is; database rebuilt and relinked once (most of an edit's cost when large). Each element of edits: {process_id} plus edit_exchanges' arguments, no note (one note for the change). Each activity once per request, two products of one activity included. Answer: each activity's report in request order, then transient and warnings once.

ParameterTypeRequiredDescription
databasestring✓Database name
editsstring[]✓One element per activity: {process_id} plus the arguments of edit_exchanges (remove, set_amounts, add_inputs, add_biosphere, add_waste_outputs, set_name, set_location, set_description, set_parameters, set_formulas, set_prices, set_dry_masses, set_wet_masses, set_suppliers, remove_parameters), each as edit_exchanges reads it.
notestringWhy, in a sentence, for every activity edited. Kept in the history (get_database_history) and the export's changes report.
sourceobjectWhere the change's figures come from: {document, page?, passage?}: the paper or report, page counted from 1, the words relied on. Covers the whole call (one page per exchange: one call each). Kept in the history (get_database_history) and the export's changes report.

supply_missing_product

Give a missing product a supplier for every activity lacking it: each unanswered input asking for this product (and naming supplier_activity, if given) moves to the provider, keeping amount, formula, comment, as edit_activities' set_suppliers would. Product and supplier activity: name and supplier_activity of a get_gap_report gap. Provider: a process_id here or in a dependency, making the product in a unit the lines convert from; one line it cannot supply refuses the whole change. Answers as edit_activities.

ParameterTypeRequiredDescription
databasestring✓Database name
notestringWhy, in a sentence. Kept in the history (get_database_history) of every activity it edits.
productstring✓The missing product: the name of a gap get_gap_report lists.
providerstring✓The process_id of the activity that will supply the product, in this database or one it depends on.
sourceobjectWhere the change's figures come from: {document, page?, passage?}: the paper or report, page counted from 1, the words relied on. Covers the whole call (one page per exchange: one call each). Kept in the history (get_database_history) and the export's changes report.
supplier_activitystringThe supplier_activity of that gap, when it names one. Absent: the inputs that name none.

get_database_parameters

A database's parameters, read by every process's formulas unless the process defines its own of that name: value (or formula and its value), unit, description, uncertainty. A process's own are in get_activity.

ParameterTypeRequiredDescription
databasestring✓Database name

get_database_history

Every change to a database of one's own, oldest first: when; what, in words (activities added, rewritten, deleted; exchanges edited, amounts before and after; parameters changed); author's reason, if any; the 'database' it was made on. A child lists its parent's changes first (its data carry them). Databases read from the engine's configuration have none.

ParameterTypeRequiredDescription
databasestring✓Database name

edit_database_parameters

Set or remove a database's parameters, then restate every process reading them: a line whose formula no longer gives its amount takes the formula's value; the answer lists processes that moved. Formulas in the engine's language (get_formula_language). Refused, saying why: name not one word of the language or a function's, second spelling of a parameter, non-finite value, formula that does not read, process left without value, removing a name a formula reads, moving an allocation share. Refused on databases read from the engine's configuration, as edit_exchanges.

ParameterTypeRequiredDescription
databasestring✓Database name
notestringWhy, in a sentence. Kept in the history (get_database_history) and the export's changes report.
remove_parametersstring[]Names of the database's parameters to remove, after the ones set here. Refused while a formula still reads one.
set_parametersobject[]Parameters of the database to add, or to replace under the same spelling. Each is {name} plus either value (with optional uncertainty) or formula, and optional unit and description.
sourceobjectWhere the change's figures come from: {document, page?, passage?}: the paper or report, page counted from 1, the words relied on. Covers the whole call (one page per exchange: one call each). Kept in the history (get_database_history) and the export's changes report.

list_scenarios

A database's scenarios: name and parameter values, as {process?, name, value}. To score one, send its values as a scoring request's parameters. Marked shipped: come with the database (an openLCA package's parameter sets, named after their product system); others saved on it, which databases read from the configuration cannot hold. One an edit made unusable (parameter removed, say) carries the problem.

ParameterTypeRequiredDescription
databasestring✓Database name

save_scenario

Save parameter values on a database under a name, replacing what it held; the answer lists saved scenarios. Each value {name, value}, plus process for a process's own. Refused, saying why: values a scoring request would refuse, a shipped scenario's name, a database read from the configuration (copy first).

ParameterTypeRequiredDescription
databasestring✓Database name
namestring✓Name of the scenario
parametersobject[]✓Values it sets, each {name, value} and process for a process's own parameter

drop_scenario

Drop a scenario saved on a database; the answer lists those left. Refused for an unknown name and for shipped scenarios (back at every load).

ParameterTypeRequiredDescription
databasestring✓Database name
namestring✓Name of the scenario

copy_method_collection

LCA / ACV: copy a method collection under a new name, to change it. Declared and built-in collections never change in place: their copies do. The copy scores as its source until changed, loaded at once, reads the source's files (source undeletable meanwhile). Named by the slug of 'new_name' (lower case, dashes), given in the response; a taken name is refused.

ParameterTypeRequiredDescription
collectionstring✓Method collection to copy
new_namestring✓Name of the copy; it is known by its slug

edit_method_factors

LCA / ACV: in a loaded collection of one's own (copy or upload), change, remove or add one characterization factor, or rescale or set every factor a selector reaches. 'op': set / remove name a factor by method_id (list_methods), flow_id and location (get_characterization or the method's factors), 'value' (present value) choosing among several at that place; add names method_id and the whole factor; scale / set-all name a selector 'match'. Not exactly one factor: refused with candidates; two identical factors only by selector; a selector touching nothing: refused. Response: the journal line and factors touched. Declared collections refused: copy_method_collection first.

ParameterTypeRequiredDescription
collectionstring✓Loaded method collection of one's own: a copy or an upload
factorobjectThe factor to add: {flowId, name, direction (Input or Output), value, unit, compartment {medium, subcompartment, qualifier}, cas, location}
flow_idstringThe factor's flow, for set and remove
locationstringThe factor's location, for set and remove; absent for a factor written for no location
matchobjectThe selector, for scale and set-all: {category, flowName, flowNamePrefix, cas, subcompartmentContains}, at least one of them
method_idstringThe impact category (from list_methods), for set, remove and add
new_valuenumberThe value to write, for set and set-all
opstring✓set, remove, add, scale or set-all
scalenumberThe factor to multiply by, for scale
valuenumberThe factor's present value, for set and remove, when several factors answer at that place

edit_method_categories

LCA / ACV: in a loaded collection of one's own (copy or upload), add, rename, re-unit or remove an impact category. 'op': add names 'name' and 'unit' (optional 'impact_category', 'methodology'), starting with no factor (edit_method_factors adds them); rename, set-unit, remove name 'method_id' (list_methods). A rename carries along scoring sets and unregionalized categories naming it. Refused: a name in use, removing a category a scoring set weighs (set named). Response: journal line and method_id.

ParameterTypeRequiredDescription
collectionstring✓Loaded method collection of one's own: a copy or an upload
impact_categorystringThe impact category a new one belongs to; its name when absent
method_idstringThe impact category (from list_methods), for rename, set-unit and remove
methodologystringThe methodology of a new category
namestringThe category's name, for add and rename
opstring✓add, rename, set-unit or remove
unitstringThe category's unit, for add and set-unit

edit_scoring_sets

LCA / ACV: change scoring sets of a loaded collection of one's own (copy or upload), each named by 'set'. 'op': create from 'rows' (optional 'unit'), remove, rename to 'name', set-unit to 'unit', set-multiplier to 'multiplier' (none drops it); add-row a 'row', change-row / remove-row the row of 'variable' (list_scoring_sets); set-formula of a computed 'variable'; set-score a 'score' to a 'formula', remove-score. Row: {label, terms: [{methodId, coefficient}], normalization, weight, unit}, categories by method_id (list_methods). A weighted row joins the score summing the rows; other scores left alone. Refused, in a sentence: formula naming nothing the set holds, cycle, zero normalization, removing a row a score reads otherwise. Response: journal line; undo_method_edit undoes it whole.

ParameterTypeRequiredDescription
collectionstring✓Loaded method collection of one's own: a copy or an upload
formulastringThe formula, for set-formula and set-score
multipliernumberThe display multiplier, for set-multiplier; absent to drop it
namestringThe set's new name, for rename
opstring✓create, remove, rename, set-unit, set-multiplier, add-row, change-row, remove-row, set-formula, set-score or remove-score
rowobjectThe row, for add-row and change-row: {label, terms: [{methodId, coefficient}], normalization, weight, unit}
rowsstring[]The rows of a new set, for create
scorestringThe score's name, for set-score and remove-score
setstring✓The scoring set (from list_scoring_sets); for create, the new set's name
unitstringThe set's unit, for create and set-unit
variablestringThe row or computed variable (from list_scoring_sets), for change-row, remove-row and set-formula

undo_method_edit

LCA / ACV: undo a change to a collection of one's own by writing its inverse as a new journal line. No 'line': latest change in effect, so repeated calls walk back one at a time, never into what a copy took from its source's configuration. 'line': that line, whatever it is (an undo line: redone). Selectors undone by restoring replaced values; a factor a later line changed refuses that, named.

ParameterTypeRequiredDescription
collectionstring✓Loaded method collection of one's own
lineintegerThe journal line to undo (from get_method_history); the latest change in effect when absent

get_method_history

LCA / ACV: a method collection's journal, one entry per change: line, when, what (category, factor, values before and after, selector and factors touched), whether it undoes another line, whether still in effect. Declared collections: empty.

ParameterTypeRequiredDescription
collectionstring✓Method collection name

search_method_flows

LCA / ACV: flows a loaded collection characterizes, once per direction and compartment, whose name holds every word of 'q' (case aside), by name. Gives flow_id and compartment for writing a new factor.

ParameterTypeRequiredDescription
collectionstring✓Loaded method collection
limitintegerMax flows to return, in name order (default: 50)
qstringWords the flow name holds; every flow when absent