Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Add guidance on GitHub autolinked reference formatting for AI agents

Aberta Para iniciantes
  • Algo errado?
#3,042 2 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
88/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
go
Domínio
tooling

Direção de pesquisa

Comece em pkg/github/toolset_instructions.go, em generateContextToolsetInstructions(), e compare a orientação existente de github_support_docs_search. Verifique se o contexto base gerado inclui um link conciso para a documentação do GitHub sobre referências autolinked antes que as ferramentas de criação de conteúdo sejam usadas. Está concluído quando a orientação cobrir referências de issue, pull request, comment e discussion sem adicionar uma nova ferramenta nem duplicá-la em outros toolsets.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement
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.

Linguagem predominante
Go
Estrelas
33.3k
Forks
5.1k
Merge médio
1d 1h
PRs com merge (30d)
19

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de github/github-mcp-server

Todas as issues de github/github-mcp-server

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.