Cómo trabajar con la documentación

Cómo aprovechar la documentación de forma efectiva en Cursor mediante indicaciones, fuentes externas y contexto interno

Por qué la documentación importa

La documentación proporciona contexto actual y preciso. Sin ella, los modelos usan datos de entrenamiento desactualizados o incompletos. La documentación ayuda a los modelos a entender cosas como:

• APIs y parámetros vigentes
• Mejores prácticas
• Convenciones de la organización
• Terminología del dominio

Y mucho más. Sigue leyendo para aprender cómo usar la documentación directamente en Cursor sin tener que cambiar de contexto.

Límite de conocimiento del modelo

Los modelos de lenguaje grandes se entrenan con datos hasta un momento específico, llamado “límite de conocimiento”. Esto implica:

• Actualizaciones recientes de bibliotecas pueden no estar reflejadas
• Nuevos frameworks o herramientas pueden ser desconocidos
• Cambios en las APIs posteriores a la fecha límite pueden no aparecer
• Las mejores prácticas pueden haber evolucionado desde el entrenamiento

Por ejemplo, si el límite de conocimiento de un modelo es a inicios de 2024, no conocerá las funcionalidades lanzadas a finales de 2024, incluso en frameworks populares.

¿Qué herramienta debería usar?

Usa este árbol de decisión para determinar rápidamente el mejor enfoque para tus necesidades de documentación:

Modelo mental

Herramienta	Modelo mental
@Docs	Como navegar y leer la documentación oficial
@Web	Como buscar soluciones en Internet
MCP	Como acceder a tu documentación interna

Documentación pública

La documentación externa abarca información de acceso público sobre la que los modelos pueden tener un conocimiento limitado o desactualizado. Cursor ofrece dos formas principales de acceder a esta información.

Uso de @Docs

@Docs conecta Cursor con la documentación oficial de herramientas y frameworks populares. Úsalo cuando necesites información actualizada y autorizada sobre:

• Referencias de API: Firmas de funciones, parámetros, tipos de retorno
• Guías de inicio: Puesta en marcha, configuración, uso básico
• Buenas prácticas: Patrones recomendados por la fuente
• Depuración específica del framework: Guías oficiales de solución de problemas

@

@Docs Next.js How do I set up dynamic routing with catch-all routes?

∞

Agent⌘I

Auto

↑

Usar @Web

@Web busca en internet en tiempo real información actual, publicaciones de blogs y discusiones de la comunidad. Úsalo cuando necesites:

• Tutoriales recientes: Contenido y ejemplos generados por la comunidad
• Comparaciones: Artículos que comparan distintos enfoques
• Actualizaciones recientes: Actualizaciones o anuncios muy recientes
• Múltiples perspectivas: Diferentes maneras de abordar problemas

@

@Web latest performance optimizations for React 19

∞

Agent⌘I

Auto

↑

Documentación interna

La documentación interna incluye información específica de tu organización que los modelos de IA nunca han encontrado durante su entrenamiento. Esto puede incluir:

• APIs internas: Servicios a medida y microservicios
• Estándares de la empresa: Convenciones de código, patrones de arquitectura
• Sistemas propietarios: Herramientas a medida, bases de datos, flujos de trabajo
• Conocimiento del dominio: Lógica de negocio, requisitos de cumplimiento normativo

Acceso a documentación interna con MCP

Model Context Protocol (MCP) ofrece una forma estandarizada de incorporar tu documentación y sistemas privados en Cursor. MCP actúa como una capa ligera entre Cursor y tus recursos internos.

Por qué MCP es importante:

• Los modelos no pueden adivinar tus convenciones internas
• La documentación de APIs para servicios personalizados no está disponible públicamente
• La lógica de negocio y el conocimiento del dominio son propios de tu organización
• Los requisitos de cumplimiento y seguridad varían según la empresa

Integraciones comunes de MCP

Integración	Acceso	Ejemplos
Confluence	Espacios de Confluence de la empresa	Documentación de arquitectura, especificaciones de APIs para servicios internos, estándares y guías de código, documentación de procesos
Google Drive	Documentos y carpetas compartidos	Documentos de especificación, notas de reuniones y registros de decisiones, documentos de diseño y requisitos, bases de conocimiento del equipo
Notion	Bases de datos y páginas del workspace	Documentación de proyectos, wikis de equipo, bases de conocimiento, requisitos de producto, especificaciones técnicas
Custom	Sistemas y bases de datos internos	APIs propietarias, sistemas de documentación heredados, bases de conocimiento personalizadas, herramientas y flujos de trabajo especializados

Soluciones personalizadas

Para necesidades específicas, puedes crear servidores MCP personalizados que:

• Hagan scraping de sitios web o portales internos
• Se conecten a bases de datos propietarias
• Accedan a sistemas de documentación personalizados
• Extraigan información de wikis internos o bases de conocimiento

Si creas un servidor MCP personalizado, también puedes exponer herramientas para que Cursor actualice la documentación

Ejemplo de servidor MCP personalizado para hacer scraping de documentación interna:

TypeScript

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";

// Create an MCP server for scraping internal docs
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Add tool to scrape internal documentation
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Convert HTML to markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Error scraping ${url}: ${error.message}` }]
      };
    }
  }
);

// Start receiving messages on stdin and sending messages on stdout
const transport = new StdioServerTransport();
await server.connect(transport);

Mantener la documentación al día

La documentación se queda desactualizada rápido. Cursor puede ayudarte a mantenerla al día y útil generándola y actualizándola a partir de tu código real y tus conversaciones de desarrollo.

A partir del código existente

Usa Cursor para generar documentación directamente desde tu codebase:

API Documentation

@

Genera documentación de la API para este router de Express, incluyendo todos los endpoints, parámetros y formatos de respuesta

∞

Agent⌘I

Auto

↑

Desde sesiones de chat

Tus conversaciones con Cursor contienen información valiosa que puede convertirse en documentación.

Resolución de problemas

Después de resolver un problema complejo:

@

Resume nuestra conversación sobre cómo configurar la autenticación en una guía paso a paso para el wiki del equipo

∞

Agent⌘I

Auto

↑

Conclusiones

• Usar la documentación como contexto hace que Cursor sea más preciso y esté actualizado
• Usa @Docs para la documentación oficial y @Web para el conocimiento de la comunidad
• MCP conecta Cursor con tus sistemas internos
• Genera documentación a partir del código y las conversaciones para mantener el conocimiento al día
• Combina fuentes de documentación internas y externas para una comprensión completa