Add guidance on GitHub autolinked reference formatting for AI agents
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 88/100
Línea de trabajo
Comienza en pkg/github/toolset_instructions.go, en generateContextToolsetInstructions(), y compara la guía existente de github_support_docs_search. Verifica que el contexto base generado incluya un enlace conciso a la documentación de GitHub sobre referencias autovinculadas antes de usar las herramientas de creación de contenido. Se considera terminado cuando la guía cubra las referencias de issue, pull request, comment y discussion sin añadir una herramienta nueva ni duplicarla en otros toolsets.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Describe the feature or problem you'd like to solve
AI agents using the MCP server create manual markdown links when they could use GitHub's built-in autolinked references instead. GitHub automatically renders patterns like #123, @username, and owner/repo#123 as clickable links across issues, pull requests, comments, and discussions—but agents lack this knowledge in their system instructions.
For complete reference and examples, see:
https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls
Proposed solution
Add guidance to the base context instructions (via generateContextToolsetInstructions()) so all agents learn about autolinked references before using any content-creation tools. This ensures consistent formatting across all GitHub interactions without duplicating guidance in multiple toolsets.
Benefits:
- Universal coverage: Applies to all content-creation tools (issues, PRs, comments, discussions)
- Single source of truth: One place to maintain, not scattered across toolsets
- Early discovery: Agents see this guidance at initialization, before using any specific tool
- No duplication: Leverage official docs instead of repeating content
Implementation:
Add a section to pkg/github/toolset_instructions.go in generateContextToolsetInstructions():
func generateContextToolsetInstructions(_ *inventory.Inventory) string {
return `Always call 'get_me' first to understand current user permissions and context.
### GitHub Autolinked References
When creating issues, pull requests, comments, or discussions, use GitHub's autolinked reference syntax—issue numbers (#123), user mentions (@example-username), and cross-repo references (example-owner/example-repo#123)—so GitHub renders them as links automatically.
See the official docs for complete details: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md`
}
This approach follows the existing pattern of github_support_docs_search, which references official documentation rather than duplicating content.
Additional context
This is a lightweight enhancement that integrates seamlessly into the existing base context instructions. No new tools or infrastructure required—just a brief instruction pointing agents to official GitHub docs.
Future enhancement:
If agents need to proactively request formatting guidance (e.g., "How should I format this reference?"), consider creating a dedicated resource or skill in the MCP server. This would allow agents to ask for formatting help on-demand while still having the baseline guidance available at initialization. This can be explored as a follow-up if needed.
- Lenguaje dominante
- Go
- Estrellas
- 33.1k
- Forks
- 5k
- Merge medio
- 2 d 15 h
- PR fusionados (30 d)
- 27
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de github/github-mcp-server
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
github/github-mcp-server#3235 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
github/github-mcp-server#3032 · 1 reacción ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
github/github-mcp-server#2803 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
github/github-mcp-server#2740 ·
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
github/github-mcp-server#2661 · 1 comentario ·
Todos los issues de github/github-mcp-server
Issues similares
-
kind/bug needs-triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
matrixorigin/matrixone#29223 ·
-
needs-acceptance wg/data-plane-networking
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
vllm-project/semantic-router#4024 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
alexgorbatchev/dotfiles#107 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 84/100