Recommend job-free build metadata lookups#3136
Closed
mitchbne wants to merge 2 commits into
Closed
Conversation
![buildsworth-bk-app[bot]](https://avatars.githubusercontent.com/in/3010600?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
One non-blocking docs consistency note inline.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 4855, then answer my questions about the findings.
Contributor
|
Thanks for the PR, @mitchbne! Moving the work on it to the dedicated space. |
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
3 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.
Description
Build metadata requests currently demonstrate responses that include jobs, even when consumers only need build state, branch, commit, creator, or timestamps. This makes larger REST responses appear to be the default and misrepresents the job-free behavior of the MCP build tools.
Recommend
exclude_jobs=truein the four primary REST list/get examples, documentexclude_pipeline=truefor callers that do not need expanded pipeline information, and preserve examples showing how to retrieve embedded jobs. Align the MCP tool inventory and LLM page descriptions with buildkite-mcp-server v1.8+, directing job-detail workflows tolist_jobsandget_job.Compatibility and deployment risk
Low. This changes documentation only and does not change API or MCP behavior. Existing REST consumers can continue requesting embedded jobs by omitting
exclude_jobs=true.Rollback
Revert this PR to restore the previous examples and descriptions. No migration or deployment coordination is required.