docs(ruby-gem): document MCP envelope results - #1238
Open
gildesmarais wants to merge 2 commits into
Open
Conversation
Document YAML capture, apply's zero-item ship gate, inspect recon, and mcp.json Botasaurus env so agents stop teaching Faraday-only auto.
Point MCP guides at ok/next_step/guidance/payload so agents stop reading _meta or a raw items array.
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
1 participant
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.
What changed
mcp-server.mdx,ai-agent-workflows.mdx, andcapturing-feed-configs.mdxdescribe the MCP envelope (ok,next_step,guidance,payload) instead of_meta/ raw JSON arrays.auto= Faraday then Botasaurus), YAML capture, apply ship gate, andhtml2rss://runtimeboolean-only.Why
The gem MCP contract on #467 is a breaking result shape. Public docs that still teach
_metaor Faraday-onlyautowould send agents down the old path.Risk
Review map
Review map: whole PR is small — start at
src/content/docs/ruby-gem/reference/mcp-server.mdx.Validation
make lint&&make build(html2rss.github.io): exit 0