Reference

Tools

The seven read-only tools RollSummary gives your AI app: what each one returns, its inputs, who can use it and a prompt to try.

Your AI app picks the tool and fills in its inputs, so you never type these names. They are listed here so you know exactly what a connected app can read.

Note: Every tool is read-only. None of them can create, change or delete anything in RollSummary.

list_campaigns

List campaigns

Returns
The campaigns you run or play in, your role in each, how many sessions each has and when the last one was.
Inputs
None.
Who can use it
Everyone.
Try asking
“List my RollSummary campaigns.”

list_sessions

List sessions

Returns
The sessions in a campaign, newest first, with their number, title, date and a one-line summary.
Inputs
campaignId, a campaign from list_campaigns.
Who can use it
Everyone in the campaign. Players see the sessions the game master has shared with them.
Try asking
“Which sessions have we played so far?”

get_session_recap

Get session recap

Returns
Game masters get the full recap, prep notes included. Players get the session note as the game master shared it.
Inputs
sessionId, a session from list_sessions.
Who can use it
Everyone in the campaign. Game masters and players get different versions, as above.
Try asking
“What happened in our last session?”

search_notes

Search campaign notes

Returns
Wiki notes that match, such as NPCs, player characters, places, quests and lore, each with a short snippet.
Inputs
campaignId and query, what to look for.
Who can use it
Everyone in the campaign. You only find the notes you can see.
Try asking
“Who is Ireena and what do we know about her?”

get_note

Read a note

Returns
The full text of one wiki note, together with the notes it links to.
Inputs
noteId, a note from search_notes or a linked note.
Who can use it
Anyone who can see the note.
Try asking
“Tell me everything our notes say about Vallaki.”

search_transcripts

Search session transcripts

Returns
The moments in your session transcripts where something was said at the table, with the session, speaker and timestamp.
Inputs
campaignId and query, plus an optional sessionId to search one session.
Who can use it
Campaign owners, DMs and assistant DMs only.
Try asking
“What exactly did the party promise the burgomaster? Check the transcript.”

search_library

Search the campaign library

Returns
Passages from the Library documents and annotations you can open, with the document title and page number.
Inputs
campaignId and query.
Who can use it
Everyone in the campaign, for the documents they can open.
Try asking
“What does our Library say about the Tarokka reading?”