Skip to content

Fix Genie Conversation API: document two-tool architecture (ask_genie + ask_genie_followup)#231

Open
CheeYuTan wants to merge 1 commit intodatabricks-solutions:mainfrom
CheeYuTan:feat/genie-conversation-api-rewrite
Open

Fix Genie Conversation API: document two-tool architecture (ask_genie + ask_genie_followup)#231
CheeYuTan wants to merge 1 commit intodatabricks-solutions:mainfrom
CheeYuTan:feat/genie-conversation-api-rewrite

Conversation

@CheeYuTan
Copy link
Contributor

Summary

Replaces conversation.md with 2-conversation-api.md that correctly documents the Genie Conversation API.

Critical fix

The old file documented a single ask_genie tool with an optional conversation_id parameter. In reality, there are two separate MCP tools:

  • ask_genie — for initial questions (params: space_id, question, timeout_seconds)
  • ask_genie_followup — for follow-up questions (params: space_id, conversation_id, question, timeout_seconds)

Other corrections

Old (incorrect) New (verified)
Status values: COMPLETED, FAILED, CANCELLED, TIMEOUT Status values: COMPLETED, ERROR, TIMEOUT
Data values are native types Data values are always strings (including numbers)
Large numbers are normal decimals Large numbers may use scientific notation (e.g., "3.336E8")
text_response only for clarifications text_response appears on both SQL results and text-only responses
description always present description only present on successful SQL queries

Also updated

  • SKILL.md: Fixed Conversation API tool table to list both tools; updated reference link
  • install_skills.sh: Updated extra files from conversation.md to 2-conversation-api.md

Test Evidence

15 API calls across 10 iterations against a live Genie Space:

Test Tool Result
Basic question ask_genie COMPLETED — all 10 response fields verified
Follow-up question ask_genie_followup COMPLETED — context maintained
Invalid space_id ask_genie ERROR — "You need Can View permission"
Invalid conversation_id ask_genie_followup ERROR — "User does not own conversation"
Empty question ask_genie ERROR — "Field 'content' is required"
Off-topic question ask_genie COMPLETED — text_response only, no SQL/data
Short timeout (3s) ask_genie TIMEOUT — verified timeout message
Vague question ask_genie COMPLETED — clarification in text_response
Follow-up after clarification ask_genie_followup COMPLETED — context maintained
Multi-column response ask_genie COMPLETED — columns/data alignment verified
Large result (553 rows) ask_genie COMPLETED — consistent shape at scale
3-turn conversation both tools COMPLETED — multi-turn workflow verified
Scientific notation ask_genie Discovered and documented
Custom timeout (60s) ask_genie COMPLETED — parameter works
End-to-end validation ask_genie COMPLETED — all docs verified

…tecture

Replace conversation.md with 2-conversation-api.md that correctly
documents ask_genie and ask_genie_followup as separate MCP tools.
The old file incorrectly showed a single tool with optional conversation_id.

Also fixes: status values are COMPLETED/ERROR/TIMEOUT (not FAILED/CANCELLED),
data values are always strings, and text_response appears on both SQL and
text-only responses.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant