Repository navigation
docs(adr): add ADR-0031, paginated vocabulary listing for structured editors - #799
Merged
Merged
Conversation
4 tasks
github-project-automation
Bot
moved this from Backlog
to Done
in Make Workshop Great Again
e54-bot
added a commit
to wrightkit/workshop-rs
that referenced
this pull request
Oct 19, 2026
…lary (#509) lookup_entries returns one LookupMatch per entry of a listable kind in catalog order, with no matching or ranking: Builtin matches for Action, Value, and Event, EnumDomain matches for Enum. Both are built by the same per-entry constructors lookup uses, so the two cannot diverge. Undeclared locales and non-listable kinds return WorkshopError::Unsupported. Wright's listEntries operation (ADR-0031, wrightkit/wright#799) pages over the result; enum members remain covered by lookup_within. Fixes #506 Co-authored-by: Teakowa <git@teakowa.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds ADR-0031, which records option 1 from #782. A separate operation,
listEntries, lists the owner's vocabulary page by page for structured editors.lookupkeeps its agent bounds. ADR-0021 decision 3 ("never returns a whole catalog") now applies tolookuponly.language:workshop; anything else returnsunavailable.kind(required):action,value,event,enum, orenumMember.within: an enum domain; required forenumMember.locale,pageSize(default 100, max 500), andcursor.lookup's entry shape, in owner order with no sorting or grouping, together withtotalandnextCursor.invalid-cursor.workshop-rsadds a public call that returns lookup facts for every entry of a kind. Enum members already come fromlookup_withinwithout a query. Wright assembles no signatures. Tracked in List lookup facts for every entry of a kind in catalog order workshop-rs#506.serveonly, on stdio and JSON-RPC. Not in the MCP tool set, and no CLI command.Why now
The structured editor prototype cannot fill in-game-style dropdowns:
lookupquery returns nothing.withinis capped at 10, which truncates domains such asHeroandMap.enumfacts carry display names but no member identities.Review
Accepted by the owner, including the two open points:
listEntriesis not exposed through MCP or the CLI, and pages default to 100 entries with a maximum of 500.Closes #782. Documentation only; no code or behavior changes.