Saltar al contenido principal

​
Visión general de herramientas

Linkly AI expone tres herramientas a los asistentes de IA a través de MCP (Model Context Protocol), conformando un flujo de trabajo progresivo de acceso a documentos: 
search → outline → read
búsqueda  esquema   lectura

search

Buscar documentos, encontrar resultados relevantes

outline

Ver el esquema del documento, comprender la estructura

read

Leer el contenido del documento, obtener detalles
Estas tres herramientas trabajan en conjunto, permitiendo que los asistentes de IA obtengan información de contexto de manera eficiente desde sus documentos locales. Busca en los documentos locales indexados y devuelve la lista de resultados más relevantes.

​
Parámetros

ParámetroTipoObligatorioPredeterminadoDescripción
querystringSí—Palabras clave o frase de búsqueda
limitnumberNo20Número máximo de resultados (1-50)
doc_typesstring[]NoTodosFiltrar por tipo de documento, ej. ["pdf", "md", "docx"]
output_formatstringNomarkdownEstablezca json para obtener salida JSON estructurada
Si el modelo vectorial aún se está descargando, la búsqueda degradará automáticamente a modo de solo palabras clave, sin afectar el uso.

​
Campos de respuesta

Cada resultado de búsqueda incluye la siguiente información:
CampoDescripción
doc_idIdentificador único del documento, usado para llamadas posteriores de outline/read
titleTítulo del documento
pathRuta del archivo
relevancePuntuación de relevancia (0-1)
word_countCantidad de palabras del documento
total_linesNúmero total de líneas del documento
has_outlineSi tiene esquema disponible
modified_atFecha de última modificación
keywordsLista de palabras clave extraídas
snippetFragmento del contenido coincidente

​
Ejemplo de uso

# Vía CLI
linkly search "mejores prácticas de gestión de proyectos" --limit 10

# Filtrar tipo de documento
linkly search "informe trimestral" --type pdf,docx --json

​
Esquema (outline)

Obtiene el esquema estructurado y los metadatos de uno o más documentos, ayudando a comprender rápidamente la estructura del documento y localizar las secciones objetivo.

​
Parámetros

ParámetroTipoObligatorioPredeterminadoDescripción
doc_idsstring[]Sí—Lista de IDs de documentos (de los resultados de búsqueda)
expandstring[]NoAutomáticoIDs de nodos a expandir (ej. ["2", "3.1"]); si se omite, se muestran todos los niveles
output_formatstringNomarkdownEstablezca json para obtener salida JSON estructurada

​
Cuándo usar el esquema

EscenarioRecomendación
Documento extenso (> 200 líneas) con esquemaVer primero el esquema, luego leer las secciones objetivo
Documento corto (< 100 líneas)Omitir el esquema, usar directamente read para el texto completo
Documento con has_outline: falseOmitir el esquema, usar directamente read para navegar página por página
La función de esquema funciona mejor con PDF con marcadores, Markdown y DOCX. Al leer documentos extensos o libros, obtendrá resultados significativamente más eficientes. El soporte de esquema para texto plano y PDF sin marcadores se proporcionará en futuras iteraciones.

​
Ejemplo de uso

# Ver esquema de un solo documento
linkly outline abc123

# Ver múltiples documentos en lote
linkly outline id1 id2 id3

# Salida en formato JSON
linkly outline abc123 --json

​
Lectura (read)

Lee el contenido del documento con soporte para posicionamiento por número de línea y paginación, ideal para leer partes específicas de documentos extensos. El comportamiento de la herramienta Read es consistente con el de Claude AI SDK, logrando así los mejores resultados en diversos modelos de IA agéntica.

​
Parámetros

ParámetroTipoObligatorioPredeterminadoDescripción
doc_idstringSí—ID del documento (de los resultados de búsqueda)
offsetnumberNo1Línea de inicio (desde 1)
limitnumberNo200Número de líneas a leer (máximo 500)
output_formatstringNomarkdownEstablezca json para obtener salida JSON estructurada

​
Formato de contenido

La herramienta Read devuelve contenido con números de línea, facilitando la referencia y el posicionamiento: 
  1	# Documento de requisitos del proyecto
  2
  3	## 1. Antecedentes del proyecto
  4
  5	Este proyecto tiene como objetivo construir un sistema eficiente de gestión del conocimiento...
  6	Los usuarios objetivo son equipos de desarrollo empresarial y trabajadores del conocimiento individuales.

​
Estrategia de paginación

Para documentos extensos, se recomienda la lectura por bloques: 
# Primera página: líneas 1-200
linkly read <DOC_ID> --offset 1 --limit 200

# Segunda página: líneas 201-400
linkly read <DOC_ID> --offset 201 --limit 200

# Tercera página: líneas 401-600
linkly read <DOC_ID> --offset 401 --limit 200
Combinar con el esquema es aún más efectivo: localice el rango de líneas de la sección objetivo a través del esquema y luego use read para leer con precisión el contenido de ese intervalo.

​
Ejemplo de uso

# Leer el inicio del documento
linkly read abc123

# Leer un rango específico
linkly read abc123 --offset 120 --limit 80

# Formato JSON (adecuado para procesamiento programático)
linkly read abc123 --json

​
Ejemplo de invocación

​
Flujo de trabajo completo: vía CLI

El siguiente ejemplo demuestra cómo completar una búsqueda de documentos completa mediante CLI: 
# Paso 1: Buscar documentos relevantes
linkly search "diseño de arquitectura de microservicios" --limit 5

# Paso 2: Ver el esquema del documento objetivo (supongamos que doc_id es abc123)
linkly outline abc123

# Paso 3: Leer la sección de interés (supongamos que está entre las líneas 80-150)
linkly read abc123 --offset 80 --limit 70

​
Flujo de trabajo completo: vía MCP

Cuando el asistente de IA invoca las herramientas a través del protocolo MCP, el formato de solicitud es el siguiente: 
// Paso 1: Búsqueda
{
  "method": "tools/call",
  "params": {
    "name": "search",
    "arguments": {
      "query": "diseño de arquitectura de microservicios",
      "limit": 5
    }
  }
}

// Paso 2: Ver esquema
{
  "method": "tools/call",
  "params": {
    "name": "outline",
    "arguments": {
      "doc_ids": ["abc123"]
    }
  }
}

// Paso 3: Leer contenido
{
  "method": "tools/call",
  "params": {
    "name": "read",
    "arguments": {
      "doc_id": "abc123",
      "offset": 80,
      "limit": 70
    }
  }
}

​
Preguntas frecuentes

Linkly AI actualmente es compatible con los siguientes formatos:
FormatoExtensiónSoporte de esquema
Markdown.md, .mdxSí
Word.docxSí
PDF.pdfParcial
Texto plano.txtNo
HTML.html, .htmParcial
Si el documento no tiene un esquema disponible (has_outline: false), puede:
  1. Usar directamente la herramienta read para navegar por el contenido del documento página por página
  2. Leer primero el inicio del documento (200 líneas por defecto) para tener una idea general del contenido antes de decidir si continuar leyendo
Flujo recomendado:
  1. Primero, comprender la estructura del documento a través de outline (si tiene esquema)
  2. Según el rango de líneas del esquema, usar los parámetros offset y limit de read para leer con precisión las secciones objetivo
  3. Leer como máximo 500 líneas por vez, paginando mediante el ajuste de offset
El puerto predeterminado es 60606. Si ese puerto está ocupado, la aplicación intentará automáticamente otros puertos. Puede consultar el puerto en uso en la configuración de Linkly AI Desktop.
Puede intentar:
  • Usar palabras clave más precisas
  • Usar descripciones en lenguaje natural (aprovechando la coincidencia semántica vectorial)
  • Combinar palabras clave y sinónimos, como "autenticación auth inicio de sesión sign-in"
  • Usar --type para filtrar tipos de documentos específicos y reducir el alcance de la búsqueda