Conversation
…llout in linking skill - Add selfhosted-agent-render skill with envelope example and all five artifact kinds - Document diff patch vs oldContent/newContent and warn against using content - Add matching diff field note to agent-render-linking after patch example Co-authored-by: Aanish Bhirud <baanish@users.noreply.github.com>
Deploying agent-render with
|
| Latest commit: |
29bbce6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://17dfa37c.agent-render.pages.dev |
| Branch Preview URL: | https://cursor-selfhosted-skill-arti.agent-render.pages.dev |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates to two SKILL.md files clarifying artifact shape requirements for diff artifacts and other artifact kinds. The changes explicitly state that diff artifacts disallow the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Resolve add/add conflict in skills/selfhosted-agent-render/SKILL.md by keeping the UUID server workflow from main and inserting per-kind envelope examples plus the diff/content validation callout. Co-authored-by: Aanish Bhirud <baanish@users.noreply.github.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 29bbce67ab
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| --- | ||
| name: selfhosted-agent-render | ||
| description: Create and manage agent-render artifacts via a self-hosted UUID-based server. Use when an agent needs to share rendered artifacts through short UUID links instead of fragment-encoded URLs. Ideal when payloads exceed the ~8 KB fragment budget, when links will be shared on platforms that mangle long URLs, or when the agent and viewer run on the same machine. Supports markdown, code, diffs, CSV, and JSON — same artifact kinds as the fragment-based product. The self-hosted server stores payloads in SQLite with a 24-hour sliding TTL. | ||
| description: Create and manage agent-render artifacts via a self-hosted UUID-based server. Use when an agent needs to share rendered artifacts through short UUID links instead of fragment-encoded URLs. Ideal when payloads exceed the ~8 KB fragment budget, when links will be shared on platforms that mangle long URLs, or when the agent and viewer run on the same machine. Supports markdown, code, diffs, CSV, and JSON — same artifact kinds and envelope validation as the fragment-based product. The self-hosted server stores payloads in SQLite with a 24-hour sliding TTL. |
There was a problem hiding this comment.
This description now states that self-hosted mode has the same envelope validation as fragment mode, but POST /api/artifacts currently only validates that payload is a non-empty string under the size cap (selfhosted/server.ts + selfhosted/validate.ts) and does not decode or validate artifact/envelope shape. In practice, malformed envelopes are accepted at write time and only fail later when viewed, so this wording can mislead agents into relying on create-time validation and make debugging failed renders harder.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
Adds/aligns documentation for the self-hosted agent-render skill so agents can produce valid per-artifact envelopes (especially diffs), and updates the fragment-linking skill with a diff field note.
Changes:
- Added per-kind artifact schema/examples (markdown/code/diff/csv/json) to
selfhosted-agent-renderdocs, including diffpatchvsoldContent/newContent. - Added an explicit note in
agent-render-linkingdocs that diff artifacts don’t usecontent.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| skills/selfhosted-agent-render/SKILL.md | Adds per-kind artifact shapes/examples and diff guidance for self-hosted payloads. |
| skills/agent-render-linking/SKILL.md | Adds a short note clarifying required diff fields vs content. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
| ``` | ||
|
|
||
| Markdown supports **mermaid** diagrams via fenced code blocks: use ` ```mermaid ` fences inside `content`; the viewer renders them client-side with theme-aware styling. |
There was a problem hiding this comment.
The inline code span ```mermaid contains backticks inside a single-backtick code span, which breaks Markdown rendering on GitHub. Reword this to avoid nesting backticks (e.g., refer to a fenced code block starting with "```mermaid" without wrapping the triple backticks in single-backtick inline code, or use a longer inline-code delimiter).
| Markdown supports **mermaid** diagrams via fenced code blocks: use ` ```mermaid ` fences inside `content`; the viewer renders them client-side with theme-aware styling. | |
| Markdown supports **mermaid** diagrams via fenced code blocks: use fenced code blocks starting with "```mermaid" inside `content`; the viewer renders them client-side with theme-aware styling. |
| } | ||
| ``` | ||
|
|
||
| > **Common mistake:** Diff artifacts do NOT use a `content` field. Use `patch` for unified diffs or provide both `oldContent` and `newContent`. A `content` field on a diff artifact will fail envelope validation. |
There was a problem hiding this comment.
The callout says that including a content field on a diff artifact "will fail envelope validation", but the runtime validators only require a diff to have patch or oldContent+newContent and do not reject extra fields. This is potentially misleading for consumers; consider rephrasing to say content is ignored/unused for diffs (and that patch or oldContent/newContent are the required fields).
| > **Common mistake:** Diff artifacts do NOT use a `content` field. Use `patch` for unified diffs or provide both `oldContent` and `newContent`. A `content` field on a diff artifact will fail envelope validation. | |
| > **Common mistake:** Diff artifacts do NOT use a `content` field. Use `patch` for unified diffs or provide both `oldContent` and `newContent`. If `content` is included on a diff artifact, it is ignored/unused for diffs; `patch` or `oldContent` + `newContent` are the required fields. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Summary
skills/selfhosted-agent-render/SKILL.md: the repo did not contain this skill yet; the new doc mirrors the linking skill’s per-kind coverage with a self-hosted<origin>framing, full envelope example, and minimal JSON examples for each artifact kind.patchandoldContent/newContentforms, optionallanguageandview, and an explicit blockquote callout thatcontentis invalid for diffs and fails validation.skills/agent-render-linking/SKILL.md: added the requested Note after the diffpatchexample about required fields vscontent.Merge with
mainMerged latest
origin/main(UUID SQLite self-hosted server). Resolved add/add conflict onskills/selfhosted-agent-render/SKILL.mdby keeping the server/API/TTL content frommainand inserting the full per-kind artifact reference from this branch.Acceptance
patch/oldContent+newContent, notcontent.contentmistake.Summary by CodeRabbit