Skip to main content
Returns the guide to a Cometly report config, the format add_dashboard_reports and update_dashboard_report take. It is Markdown text, the same for every Space. It reads nothing from your Space and changes nothing.
If your client does not list this tool, it is not available on your connection: the connection is read-only, or your role in the Space is Viewer (or no longer allows changes).

When to use

Once, before the first add_dashboard_reports or update_dashboard_report call of a conversation.

Parameters

None.

Output

Markdown with these sections: The lists of accepted values are generated from the same code the server checks a config with, so the guide matches what the server accepts. The output starts like this:

Not covered

What belongs to a Space is not in the guide. Get it from these tools:

Availability

Offered together with create_dashboard, add_dashboard_reports and update_dashboard_report. Like them, it is hidden from read-only connections, which include every connection made by a Viewer, because it describes tools those connections don’t have. Calling it there returns “Tool not found”.