​
Por que a documentação é importante

A documentação fornece contexto atual e preciso. Sem ela, os modelos usam dados de treinamento desatualizados ou incompletos. A documentação ajuda os modelos a entender coisas como:
  • APIs e parâmetros atuais
  • Melhores práticas
  • Convenções da organização
  • Terminologia do domínio
E muito mais. Continue lendo para aprender como usar a documentação diretamente no Cursor sem precisar alternar o contexto.

​
Limite de conhecimento do modelo

Modelos de linguagem grandes são treinados com dados até um ponto específico no tempo, chamado de “limite de conhecimento”. Isso significa:
  • Atualizações recentes de bibliotecas podem não estar refletidas
  • Novos frameworks ou ferramentas podem ser desconhecidos
  • Mudanças de API após a data limite são perdidas
  • Melhores práticas podem ter evoluído desde o treinamento
Por exemplo, se o limite de conhecimento de um modelo é no início de 2024, ele não saberá sobre recursos lançados no final de 2024, mesmo para frameworks populares.

​
Qual ferramenta devo usar?

Use esta árvore de decisão para determinar rapidamente a melhor abordagem para suas necessidades de documentação:

​
Modelo mental

FerramentaModelo Mental
@DocsComo navegar e ler documentação oficial
@WebComo buscar soluções na internet
MCPComo acessar sua documentação interna

​
Documentação pública

A documentação externa abrange informações publicamente disponíveis sobre as quais os modelos podem ter conhecimento limitado ou desatualizado. O Cursor oferece duas maneiras principais de acessar essas informações.

​
Usando @Docs

@Docs conecta o Cursor à documentação oficial de ferramentas e frameworks populares. Use quando precisar de informações atuais e confiáveis sobre:
  • Referências de API: Assinaturas de função, parâmetros, tipos de retorno
  • Guias de início: Configuração, setup, uso básico
  • Melhores práticas: Padrões recomendados pela fonte
  • Depuração específica de framework: Guias oficiais de solução de problemas
@
@Docs Next.js Como configuro roteamento dinâmico com rotas catch-all?
∞
Agent⌘I
Auto

​
Usando @Web

@Web pesquisa na internet ao vivo por informações atuais, posts de blog e discussões da comunidade. Use quando você precisar de:
  • Tutoriais recentes: Conteúdo e exemplos gerados pela comunidade
  • Comparações: Artigos comparando diferentes abordagens
  • Atualizações recentes: Atualizações ou anúncios muito recentes
  • Múltiplas perspectivas: Diferentes abordagens para problemas
@
@Web otimizações de performance mais recentes para React 19
∞
Agent⌘I
Auto

​
Documentação interna

A documentação interna inclui informações específicas da sua organização que os modelos de IA nunca encontraram durante o treinamento. Isso pode ser:
  • APIs internas: Serviços customizados e microsserviços
  • Padrões da empresa: Convenções de código, padrões de arquitetura
  • Sistemas proprietários: Ferramentas customizadas, bancos de dados, fluxos de trabalho
  • Conhecimento de domínio: Lógica de negócio, requisitos de conformidade

​
Acessando documentação interna com MCP

O Model Context Protocol (MCP) fornece uma maneira padronizada de trazer sua documentação privada e sistemas para o Cursor. O MCP atua como uma camada fina entre o Cursor e seus recursos internos. Por que o MCP é importante:
  • Os modelos não conseguem adivinhar suas convenções internas
  • A documentação de API para serviços personalizados não está disponível publicamente
  • A lógica de negócios e o conhecimento de domínio são únicos para sua organização
  • Os requisitos de conformidade e segurança variam por empresa

​
Integrações MCP comuns

IntegraçãoAcessoExemplos
ConfluenceEspaços Confluence da empresaDocumentação de arquitetura, especificações de API para serviços internos, padrões e diretrizes de codificação, documentação de processos
Google DriveDocumentos e pastas compartilhadosDocumentos de especificação, notas de reunião e registros de decisões, documentos de design e requisitos, bases de conhecimento da equipe
NotionBancos de dados e páginas do workspaceDocumentação de projetos, wikis da equipe, bases de conhecimento, requisitos de produto, especificações técnicas
PersonalizadoSistemas internos e bancos de dadosAPIs proprietárias, sistemas de documentação legados, bases de conhecimento personalizadas, ferramentas e fluxos de trabalho especializados

​
Soluções personalizadas

Para necessidades únicas, você pode construir servidores MCP personalizados que:
  • Fazem scraping de sites internos ou portais
  • Conectam-se a bancos de dados proprietários
  • Acessam sistemas de documentação personalizados
  • Extraem de wikis internos ou bases de conhecimento
Se você construir um servidor MCP personalizado, também pode expor ferramentas para o Cursor atualizar a documentação
Exemplo de servidor MCP personalizado para fazer scraping de documentos internos: 
import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import TurndownService from "turndown";

// Criar um servidor MCP para fazer scraping de documentos internos
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Adicionar ferramenta para fazer scraping de documentação interna
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Converter HTML para markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Erro ao fazer scraping de ${url}: ${error.message}` }]
      };
    }
  }
);

// Começar a receber mensagens no stdin e enviar mensagens no stdout
const transport = new StdioServerTransport();
await server.connect(transport);

​
Mantendo a documentação atualizada

A documentação fica desatualizada rapidamente. O Cursor pode ajudá-lo a manter uma documentação atual e útil, gerando e atualizando-a com base no seu código real e nas conversas de desenvolvimento.

​
A partir do código existente

Use o Cursor para criar documentação diretamente da sua base de código:
@
Gere documentação de API para este roteador Express, incluindo todos os endpoints, parâmetros e formatos de resposta
∞
Agent⌘I
Auto

​
A partir de sessões de chat

Suas conversas com o Cursor contêm intenções valiosas que podem ser transformadas em documentação.
Após resolver um problema complexo:
@
Resuma nossa conversa sobre configuração de autenticação em um guia passo a passo para o wiki da equipe
∞
Agent⌘I
Auto

​
Principais Pontos

  • Documentação como contexto torna o Cursor mais preciso e atualizado
  • Use @Docs para documentação oficial e @Web para conhecimento da comunidade
  • MCP conecta o Cursor aos seus sistemas internos
  • Gere documentação a partir de código e conversas para manter o conhecimento atualizado
  • Combine fontes de documentação externas e internas para compreensão abrangente