Documentation Index
Fetch the complete documentation index at: https://linkly.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
Visión general de herramientas
Linkly AI expone siete herramientas a los asistentes de IA a través de MCP (Model Context Protocol), conformando un flujo de trabajo progresivo de acceso a documentos:list_libraries (listar bibliotecas de conocimiento), explore (visión general de colecciones de documentos) y find_paths (localizar rutas de carpeta por palabra clave para alimentar el path_glob de search).
search
Buscar documentos y encontrar resultados relevantes
outline
Ver el esquema del documento para comprender su estructura
grep
Encontrar patrones de texto específicos con coincidencia regex
read
Leer el contenido del documento para obtener información detallada
list_libraries
Listar las bibliotecas de conocimiento y sus cantidades de documentos
explore
Visión general de los temas y la estructura de la colección de documentos
find_paths
Localizar rutas de carpeta por palabra clave para alimentar el
path_glob
de searchBúsqueda (search)
Busca en los documentos locales indexados y devuelve la lista de resultados más relevantes.Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
query | string | Sí | — | Palabras clave o frase de búsqueda |
limit | number | No | 20 | Número máximo de resultados (1-50) |
doc_types | string[] | No | Todos | Filtrar por tipo de documento, ej. ["pdf", "md", "docx"] |
library | string | No | — | Restringir la búsqueda a una biblioteca específica. Utilice list_libraries para ver las bibliotecas disponibles |
path_glob | string | No | — | Filtrar por ruta de archivo (sintaxis GLOB de SQLite). * coincide con cualquier carácter (incluido /), ? coincide con un solo carácter. Siempre distingue mayúsculas y minúsculas. Cuando la ruta real es desconocida, llame primero a find_paths |
modified_after | string | No | — | Límite inferior inclusivo de la fecha de modificación. ISO 8601 UTC: fecha simple 2024-01-01 (interpretada como 00:00:00Z) o RFC 3339 completo 2024-01-01T00:00:00Z |
modified_before | string | No | — | Límite superior inclusivo de la fecha de modificación. Mismo formato que modified_after |
time_sort | string | No | default | Reordenamiento temporal: default (preserva el orden de relevancia) / newest (más reciente primero) / oldest (más antiguo primero). Solo se reordena después de seleccionar y deduplicar el conjunto de candidatos |
output_format | string | No | markdown | Establezca json para obtener salida JSON estructurada |
- Cuando el usuario indique una ventana temporal explícita (“el mes pasado”, “en 2024”, “los últimos tres meses”), use
modified_after/modified_before. - Cuando el usuario solo dice “reciente”, “más reciente”, “más antiguo” sin un rango fijo, use
time_sort=newestuoldest. - Ambos pueden combinarse: “el más antiguo en 2024” es
modified_after=2024-01-01+modified_before=2024-12-31+time_sort=oldest. - Para fechas relativas (“el mes pasado”), lea primero la hora UTC actual desde el campo
[meta] now=...al final de cualquier respuesta de herramienta, luego calcule la fecha — vea Metadatos de respuesta más abajo.
Campos de respuesta
Cada resultado de búsqueda incluye la siguiente información:| Campo | Descripción |
|---|---|
doc_id | Identificador único del documento para llamadas posteriores de outline/read |
title | Título del documento |
path | Ruta del archivo |
relevance | Puntuación de relevancia (0-1) |
word_count | Cantidad de palabras del documento |
total_lines | Número total de líneas del documento |
has_outline | Si tiene esquema disponible |
modified_at | Fecha de última modificación |
keywords | Lista de palabras clave extraídas |
snippet | Fragmento del contenido coincidente |
Ejemplos de uso
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ámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
doc_ids | string[] | Sí | — | Lista de IDs de documentos (de los resultados de búsqueda) |
expand | string[] | No | Automático | IDs de nodos a expandir (ej. ["2", "3.1"]); si se omite, se muestran todos los niveles |
output_format | string | No | markdown | Establezca json para obtener salida JSON estructurada |
Cuándo usar el esquema
| Escenario | Recomendación |
|---|---|
| Documento > 50 líneas con esquema | Ver primero el esquema, luego leer las secciones objetivo |
| Documento corto (< 50 líneas) | Omitir el esquema, usar directamente read para el texto completo |
Documento con has_outline: false | Usar grep para encontrar patrones o read página por página |
La función de esquema funciona mejor con PDF con marcadores, Markdown
y DOCX. Es especialmente efectiva al leer documentos extensos y libros. El
soporte de esquema para texto plano y PDF sin marcadores se añadirá en futuras
iteraciones.
Ejemplos de uso
Grep
Localiza líneas específicas dentro de un solo documento mediante un patrón regex. Es ideal para documentos conhas_outline=false donde el esquema no está disponible. Utilícelo después de search para ubicar posiciones exactas de nombres, fechas, términos, identificadores o cualquier patrón, y luego use read con offset para ver el contexto completo. Funciona con todos los tipos de documentos (PDF, Markdown, DOCX, TXT, HTML). Para buscar en múltiples documentos, llame a grep una vez por documento.
Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
pattern | string | Sí | — | Patrón de expresión regular a buscar |
doc_id | string | Sí | — | ID del documento en el que buscar (de los resultados de búsqueda) |
context | number | No | 3 | Líneas de contexto antes y después de cada coincidencia |
before | number | No | — | Líneas de contexto antes de cada coincidencia (anula context) |
after | number | No | — | Líneas de contexto después de cada coincidencia (anula context) |
case_insensitive | boolean | No | false | Coincidencia sin distinguir mayúsculas y minúsculas |
output_mode | string | No | content | content (líneas coincidentes con contexto) o count (solo recuento, para previsualizar totales) |
limit | number | No | 20 | Máximo de líneas coincidentes a devolver (máximo 100) |
offset | number | No | 0 | Número de coincidencias a omitir para paginación |
output_format | string | No | markdown | Establezca json para obtener salida JSON estructurada |
Cuándo usar Grep vs Esquema
| Escenario | Recomendación |
|---|---|
| Necesita encontrar un término, nombre o fecha específica | Use grep con el patrón |
| Necesita comprender la estructura general del documento | Use outline |
El documento no tiene esquema (has_outline: false) | Use grep para localizar contenido |
| Busca patrones (correos, IDs, números, etc.) | Use grep con regex |
Ejemplos de uso
Lectura (read)
Lee el contenido del documento con 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 del SDK de Claude AI, lo que garantiza resultados óptimos en diversos modelos de IA agéntica.Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
doc_id | string | Sí | — | ID del documento (de los resultados de búsqueda) |
offset | number | No | 1 | Línea de inicio (desde 1) |
limit | number | No | 200 | Número de líneas a leer (máximo 500) |
output_format | string | No | markdown | Establezca json para obtener salida JSON estructurada |
Formato de contenido
La herramientaRead devuelve contenido con números de línea para facilitar la referencia y el posicionamiento:
Estrategia de paginación
Para documentos extensos, se recomienda la lectura por bloques:read para leer con precisión el contenido de ese intervalo.
Ejemplos de uso
Listar bibliotecas (list_libraries)
Lista todas las bibliotecas de conocimiento configuradas por el usuario, junto con sus descripciones y cantidades de documentos.Parámetros
No se requieren parámetros.Casos de uso
- Cuando el usuario pregunta “¿qué bibliotecas tengo?”
- Antes de utilizar el parámetro
libraryensearch, para verificar el nombre de una biblioteca
Explorar (explore)
Obtiene una visión panorámica de todos los documentos indexados o de una biblioteca específica. Devuelve la distribución de tipos de documentos, la estructura de directorios (con recuentos de archivos y medianas de cantidad de palabras) y las palabras clave principales (con atribución de origen).Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
library | string | No | — | Restringir a una biblioteca específica. Omita para explorar todos los documentos |
Casos de uso
- El usuario desea saber qué contiene su base de conocimiento o colección de documentos
- El usuario no tiene un tema de búsqueda específico y desea descubrir temas y direcciones disponibles
- El asistente de IA necesita comprender la escala y la distribución temática para formular estrategias de búsqueda efectivas
search posteriores.
Localización de rutas (find_paths)
Realiza una coincidencia aproximada de palabras clave contra el campo ruta de archivo de los documentos indexados, agrega las coincidencias a nivel de carpeta y devuelve los mejores candidatos. Está posicionada como una herramienta auxiliar desearch: cuando el usuario nombra un contenedor (“en mis notas de Notion”, “en mi carpeta de papers de Dropbox”) sin conocer su ruta en el disco, llame primero a find_paths para descubrir la ruta real, y luego pásela como path_glob a search.
El nombre real de la carpeta en el disco a menudo difiere del nombre coloquial del usuario (por ejemplo, una exportación puede residir en Notion-Export-c58e430f... en lugar de simplemente Notion), por lo que adivinar directamente un path_glob es frágil.
Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
patterns | string[] | Sí | — | Arreglo de palabras clave; cada una se envuelve internamente como SQL LIKE %palabra% contra la ruta. Múltiples palabras clave se combinan por OR, así que pase varias variantes en una sola llamada (pares de traducción, mayúsculas/minúsculas, identificadores reales de aplicación/SDK), ej. ["Notion", "notion", "notion-export"]. Insensible a mayúsculas/minúsculas para ASCII; CJK coincide literalmente |
library | string | No | — | Restringir a una biblioteca específica. Utilice list_libraries para ver las bibliotecas disponibles |
limit | number | No | 10 | Número máximo de carpetas candidatas (máx 50) |
output_format | string | No | markdown | Establezca json para obtener salida JSON estructurada |
Campos de respuesta (modo JSON)
| Campo | Descripción |
|---|---|
total_files | Número total de archivos agregados a los candidatos retornados (antes del recorte por limit) |
truncated | Indica si limit cortó la lista de directorios (true significa que existen más candidatos) |
directories | Carpetas candidatas, ordenadas por file_count descendente. Cada entrada tiene path (ruta, acortada si la opción “mostrar ruta completa” no está activada) y file_count (archivos coincidentes) |
Comportamiento de agregación
- Los archivos cuyos patrones solo coinciden con el segmento de nombre de archivo (sin coincidencia en algún segmento de directorio) se descartan silenciosamente — esta es una herramienta para “encontrar carpetas”, no para “encontrar archivos”. Si una consulta no devuelve carpetas candidatas a pesar de que existan archivos coincidentes, recurra a llamar
searchdirectamente. - Cada coincidencia se agrupa por la posición menos profunda de cualquier patrón en la ruta, truncada en el siguiente
/. Asílocal:///Users/me/Documents/Notion-Export-abc/workspace/page.mdcoincidente conNotionse agrega bajo.../Documents/Notion-Export-abc, sin importar cuán profundo viva el archivo.
Cuándo usarla
- El usuario nombra un contenedor con una palabra ambigua o multilingüe (“en mis notas de Notion”, “en mi carpeta de papers de Dropbox”, “en mi respaldo de trabajo”) y no conoce la ruta real
- Antes de
search, para determinar el valor depath_glob
Cuándo no usarla
- Consultas puramente de contenido / tema (“encuentra mis CV”, “encuentra papers de IA”) — llame
searchdirectamente; su búsqueda híbrida ya cubre título, nombre de archivo, contenido y ruta - Filtrado solo por tipo de archivo (“todos los PDF”) — llame
searchconpath_glob="*.pdf"directamente - Consultas vagas sin intención de contenedor (“encuentra cosas recientes”) — llame
search
Ejemplo de uso
Metadatos de respuesta
Cada respuesta exitosa de herramienta lleva la hora UTC actual, lo que permite a quien llama calcular fechas relativas (“el mes pasado”, “este año”, “los últimos 30 días”) sin depender de la fecha de corte de entrenamiento del modelo.-
Salida Markdown: un bloque de pie de página al final de la respuesta, formateado como:
-
Salida JSON: un objeto
_metade nivel superior:
isError: true) no incluyen estos metadatos — el cuerpo del error ya transmite la causa, y agregar una marca de tiempo solo diluiría la señal.
Cuando el usuario use una fecha relativa, lea now desde la respuesta de herramienta más reciente, calcule la fecha ISO 8601 correspondiente, y pásela a modified_after / modified_before de search.
Ejemplos de flujo de trabajo
Flujo de trabajo completo: vía CLI
El siguiente ejemplo demuestra cómo realizar una búsqueda completa de documentos mediante CLI: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:Preguntas frecuentes
¿Qué formatos de documento son compatibles?
¿Qué formatos de documento son compatibles?
Linkly AI actualmente es compatible con los siguientes formatos:
| Formato | Extensiones | Soporte de esquema |
|---|---|---|
| Markdown | .md, .mdx | Yes |
| Word | .docx | Yes |
.pdf | Partial | |
| Texto plano | .txt | No |
| HTML | .html, .htm | Partial |
| Imagen (OCR) | .png, .jpg, .jpeg, .bmp, .webp | No |
¿Qué hacer si el esquema no está disponible?
¿Qué hacer si el esquema no está disponible?
Si el documento no tiene un esquema disponible (
has_outline: false), puede:- Usar directamente la herramienta
readpara navegar por el contenido del documento página por página - Leer primero el inicio del documento (200 líneas por defecto) para tener una idea general del contenido antes de decidir si continuar leyendo
¿Cómo manejar documentos extensos?
¿Cómo manejar documentos extensos?
Flujo recomendado:
- Primero, comprender la estructura del documento a través de
outline(si tiene esquema) - Según el rango de líneas del esquema, usar los parámetros
offsetylimitdereadpara leer con precisión las secciones objetivo - Leer como máximo 500 líneas por vez, paginando mediante el ajuste de
offset
¿Cuál es el puerto predeterminado del servicio MCP?
¿Cuál es el puerto predeterminado del servicio MCP?
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.
¿Qué hacer si los resultados de búsqueda no son precisos?
¿Qué hacer si los resultados de búsqueda no son precisos?
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
"authentication auth login sign-in" - Usar
--typepara filtrar tipos de documentos específicos y reducir el alcance de la búsqueda

