Skip to main content
Chemia Discovery
Browse the documentation

list_material_sources tool

Lists the datasets this server can query, with their ids, descriptions and whether access to them is restricted. It is not charged against the daily allowance.

At a glance
Toollist_material_sources
TitleList material sources
GroupOrient yourself
ChargedNo
Read-onlyYes
Parametersnone

What parameters does list_material_sources take?

list_material_sources takes no parameters.

Does list_material_sources use my daily allowance?

  • Charged: no, it never uses the daily allowance.
  • Who can call it: your client lists the tools your account is entitled to, so a tool appears only when you can use it.

The allowance and the account rules are explained in Access and limits.

Annotations the server sets on list_material_sources
AnnotationValueMeaning
openWorldHintfalseIf true, the tool may interact with an open world of external entities.
readOnlyHinttrueIf true, the tool does not modify its environment.

What does a call to list_material_sources look like?

No arguments.

Example arguments for list_material_sources
{}

These arguments show how a call is written and validate against the tool's input schema.

How should I read list_material_sources results?

  • Good to know. restricted means reading the dataset needs full-dataset access. is_default marks the dataset a search would use for you when neither a source_id nor the query text names one, so it can differ between accounts. specialized marks a slice of the full catalogue chosen by application.

"Good to know" explains a field whose meaning is not obvious, "Check this" marks a result that can look right and still mislead, and "Coverage note" says what the data does not cover. Reading results explains all three.

How does the server describe list_material_sources?

This is the description an assistant sees for the tool.

List the material datasets this server can query, with their ids, descriptions, and whether they are access-restricted.

list_material_sources is in the group "Orient yourself". The other tools in it:

  • list_capabilities: Lists what this server and the wider Chemia platform can do, grouped by category.

The Tool reference lists every tool.