Passer au contenu principal

Vue d’ensemble des outils

Linkly AI expose trois outils aux assistants IA via MCP (Model Context Protocol), formant un flux de travail progressif d’accès aux documents :
search → outline → read
Recherche   Sommaire   Lecture

search

Rechercher des documents et trouver les résultats pertinents

outline

Consulter le sommaire du document et comprendre sa structure

read

Lire le contenu du document et obtenir les détails
Ces trois outils fonctionnent ensemble pour permettre à l’assistant IA d’obtenir efficacement des informations contextuelles depuis vos documents locaux. Recherche dans vos documents locaux indexés et retourne la liste des résultats les plus pertinents.

Paramètres

ParamètreTypeObligatoirePar défautDescription
querystringOuiMots-clés ou expression de recherche
limitnumberNon20Nombre maximum de résultats retournés (1-50)
doc_typesstring[]NonTousFiltrer par type de document, ex. ["pdf", "md", "docx"]
output_formatstringNonmarkdownDéfinir sur json pour une sortie JSON structurée
Si le modèle vectoriel est encore en cours de téléchargement, la recherche bascule automatiquement en mode mots-clés uniquement, sans impact sur l’utilisation.

Champs retournés

Chaque résultat de recherche contient les informations suivantes :
ChampDescription
doc_idIdentifiant unique du document, utilisé pour les appels outline/read ultérieurs
titleTitre du document
pathChemin du fichier
relevanceScore de pertinence (0-1)
word_countNombre de mots du document
total_linesNombre total de lignes du document
has_outlineIndique si un sommaire est disponible
modified_atDate de dernière modification
keywordsListe des mots-clés extraits
snippetExtrait du contenu correspondant

Exemples d’utilisation

# Via CLI
linkly search "meilleures pratiques gestion de projet" --limit 10

# Filtrer par type de document
linkly search "rapport trimestriel" --type pdf,docx --json

Sommaire (outline)

Obtient le sommaire structuré et les métadonnées d’un ou plusieurs documents, permettant de comprendre rapidement la structure du document et de localiser les sections ciblées.

Paramètres

ParamètreTypeObligatoirePar défautDescription
doc_idsstring[]OuiListe d’ID de documents (issus des résultats de recherche)
expandstring[]NonAutoID des noeuds à développer (ex. ["2", "3.1"]), omis pour afficher tous les niveaux
output_formatstringNonmarkdownDéfinir sur json pour une sortie JSON structurée

Quand utiliser le sommaire

ScénarioRecommandation
Document long (> 200 lignes) avec sommaireConsulter d’abord le sommaire, puis lire les sections ciblées
Document court (< 100 lignes)Ignorer le sommaire, lire directement avec read
Document avec has_outline: falseIgnorer le sommaire, parcourir directement avec read
La fonctionnalité de sommaire est optimale pour les PDF avec signets, les documents Markdown et DOCX. Elle est particulièrement efficace pour la lecture de documents volumineux et de livres. Le support du sommaire pour le texte brut et les PDF sans signets sera ajouté dans les itérations futures.

Exemples d’utilisation

# Consulter le sommaire d'un document
linkly outline abc123

# Consulter plusieurs documents en lot
linkly outline id1 id2 id3

# Sortie au format JSON
linkly outline abc123 --json

Lecture (read)

Lit le contenu d’un document, avec positionnement par numéro de ligne et pagination, adapté à la lecture de sections spécifiques de documents longs. L’outil Read a un comportement cohérent avec celui du SDK Claude AI, ce qui lui permet d’obtenir les meilleurs résultats avec divers modèles Agentic AI.

Paramètres

ParamètreTypeObligatoirePar défautDescription
doc_idstringOuiID du document (issu des résultats de recherche)
offsetnumberNon1Numéro de ligne de départ (à partir de 1)
limitnumberNon200Nombre de lignes à lire (maximum 500)
output_formatstringNonmarkdownDéfinir sur json pour une sortie JSON structurée

Format du contenu

L’outil Read retourne le contenu avec des numéros de ligne pour faciliter le référencement et le positionnement :
  1	# Document de spécifications du projet
  2
  3	## I. Contexte du projet
  4
  5	Ce projet vise à construire un système efficace de gestion des connaissances...
  6	Les utilisateurs cibles sont les équipes R&D d'entreprise et les travailleurs du savoir individuels.

Stratégie de pagination

Pour les documents longs, il est recommandé de lire par blocs :
# Première page : lignes 1-200
linkly read <DOC_ID> --offset 1 --limit 200

# Deuxième page : lignes 201-400
linkly read <DOC_ID> --offset 201 --limit 200

# Troisième page : lignes 401-600
linkly read <DOC_ID> --offset 401 --limit 200
L’utilisation combinée avec le sommaire est encore plus efficace : localisez d’abord la plage de lignes de la section ciblée via le sommaire, puis utilisez read pour lire précisément cet intervalle.

Exemples d’utilisation

# Lire le début du document
linkly read abc123

# Lire une plage spécifique
linkly read abc123 --offset 120 --limit 80

# Format JSON (adapté au traitement programmatique)
linkly read abc123 --json

Exemples d’appels

Flux de travail complet : via CLI

L’exemple suivant illustre comment effectuer une recherche documentaire complète via le CLI :
# Étape 1 : Rechercher les documents pertinents
linkly search "conception architecture microservices" --limit 5

# Étape 2 : Consulter le sommaire du document cible (en supposant doc_id = abc123)
linkly outline abc123

# Étape 3 : Lire la section intéressante (en supposant que la cible est aux lignes 80-150)
linkly read abc123 --offset 80 --limit 70

Flux de travail complet : via MCP

Lorsque l’assistant IA appelle les outils via le protocole MCP, le format des requêtes est le suivant :
// Étape 1 : Recherche
{
  "method": "tools/call",
  "params": {
    "name": "search",
    "arguments": {
      "query": "conception architecture microservices",
      "limit": 5
    }
  }
}

// Étape 2 : Consulter le sommaire
{
  "method": "tools/call",
  "params": {
    "name": "outline",
    "arguments": {
      "doc_ids": ["abc123"]
    }
  }
}

// Étape 3 : Lire le contenu
{
  "method": "tools/call",
  "params": {
    "name": "read",
    "arguments": {
      "doc_id": "abc123",
      "offset": 80,
      "limit": 70
    }
  }
}

Questions fréquentes

Linkly AI prend actuellement en charge les formats suivants :
FormatExtensionSupport du sommaire
Markdown.md, .mdx
Word.docx
PDF.pdfPartiel
Texte brut.txt
HTML.html, .htmPartiel
Si le document n’a pas de sommaire disponible (has_outline: false), vous pouvez :
  1. Utiliser directement l’outil read pour parcourir le contenu du document par pages
  2. Lire d’abord le début du document (200 lignes par défaut) pour avoir un aperçu du contenu, puis décider si vous souhaitez poursuivre la lecture
Flux recommandé :
  1. Consulter d’abord la structure du document via outline (si un sommaire est disponible)
  2. En fonction de la plage de lignes indiquée dans le sommaire, utiliser les paramètres offset et limit de read pour lire précisément les sections ciblées
  3. Lire au maximum 500 lignes à la fois, en ajustant offset pour paginer
Le port par défaut est 60606. Si ce port est occupé, l’application essaie automatiquement d’autres ports. Vous pouvez vérifier le port réellement utilisé dans les paramètres de Linkly AI Desktop.
Vous pouvez essayer :
  • Utiliser des mots-clés plus précis
  • Utiliser des descriptions en langage naturel (en exploitant la correspondance sémantique vectorielle)
  • Combiner mots-clés et synonymes, par exemple "authentification auth connexion sign-in"
  • Utiliser --type pour filtrer des types de documents spécifiques et affiner le champ de recherche