feat: Add .well-known/skills discovery endpoint for AI agents #16234
Conversation
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
Implements the Cloudflare Agent Skills Discovery RFC to expose documentation skills at /.well-known/skills/. This allows AI coding assistants to discover and use Sentry documentation when helping users implement SDKs. Skills exposed: - sentry-docs: SDK setup, configuration, and troubleshooting - technical-docs: Documentation writing guidelines - docs-review: Sentry style guide for reviewers Also adds documentation pages: - /agentic-usage/ for SDK users - /contributing/agentic-usage/ for doc contributors Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Vercel doesn't follow symlinks during build. This adds a copy-skills script that copies skill files from .claude/skills/ to public/.well-known/skills/ during build. Co-Authored-By: Claude <noreply@anthropic.com>
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+9
to
+19
| "name": "technical-docs", | ||
| "description": "Write and review technical documentation for Sentry SDK docs. Use when creating, editing, or reviewing documentation pages, especially MDX files in docs/platforms/.", | ||
| "files": ["SKILL.md"] | ||
| }, | ||
| { | ||
| "name": "docs-review", | ||
| "description": "Review documentation for Sentry style and voice. Use when reviewing or writing user-facing documentation to ensure it follows the Sentry documentation style guide.", | ||
| "files": ["SKILL.md"] | ||
| } | ||
| ] | ||
| } |
There was a problem hiding this comment.
Bug: The global trailingSlash: true setting will cause a redirect for /.well-known/skills/index.json, which may break clients expecting a direct file response.
Severity: HIGH
Suggested Fix
Add a specific configuration rule in vercel.json or next.config.ts to create an exception for the /.well-known/skills/index.json path, disabling the trailing slash redirect for this specific file to ensure it is served directly.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: public/.well-known/skills/index.json#L1-L19
Potential issue: The global `trailingSlash: true` configuration in both `next.config.ts`
and `vercel.json` will cause requests for the `/.well-known/skills/index.json` file to
receive a 308 redirect to `/.well-known/skills/index.json/`. This behavior contradicts
the standard convention for serving JSON files and will likely cause issues for clients
attempting to discover skills, as they typically expect a direct file response without a
trailing slash and may not handle the redirect correctly.
Did we get this right? 👍 / 👎 to inform future reviews.
Member
Author
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
/.well-known/skills/Skills exposed:
sentry-docstechnical-docsdocs-reviewDocumentation pages added:
/agentic-usage/- For SDK users using AI agents/contributing/agentic-usage/- For doc contributorsNote: Skill files are copied at build time instead of using symlinks because Vercel doesn't follow symlinks.
Test plan
yarn buildsucceedsyarn build:developer-docssucceeds/.well-known/skills/index.jsonreturns skills manifest/.well-known/skills/sentry-docs/SKILL.mdreturns content/agentic-usage/page renders/contributing/agentic-usage/page renders🤖 Generated with Claude Code