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
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
Recherche (search)
Recherche dans vos documents locaux indexés et retourne la liste des résultats les plus pertinents.Paramètres
| Paramètre | Type | Obligatoire | Par défaut | Description |
|---|---|---|---|---|
query | string | Oui | — | Mots-clés ou expression de recherche |
limit | number | Non | 20 | Nombre maximum de résultats retournés (1-50) |
doc_types | string[] | Non | Tous | Filtrer par type de document, ex. ["pdf", "md", "docx"] |
output_format | string | Non | markdown | Définir sur json pour une sortie JSON structurée |
Champs retournés
Chaque résultat de recherche contient les informations suivantes :| Champ | Description |
|---|---|
doc_id | Identifiant unique du document, utilisé pour les appels outline/read ultérieurs |
title | Titre du document |
path | Chemin du fichier |
relevance | Score de pertinence (0-1) |
word_count | Nombre de mots du document |
total_lines | Nombre total de lignes du document |
has_outline | Indique si un sommaire est disponible |
modified_at | Date de dernière modification |
keywords | Liste des mots-clés extraits |
snippet | Extrait du contenu correspondant |
Exemples d’utilisation
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ètre | Type | Obligatoire | Par défaut | Description |
|---|---|---|---|---|
doc_ids | string[] | Oui | — | Liste d’ID de documents (issus des résultats de recherche) |
expand | string[] | Non | Auto | ID des noeuds à développer (ex. ["2", "3.1"]), omis pour afficher tous les niveaux |
output_format | string | Non | markdown | Définir sur json pour une sortie JSON structurée |
Quand utiliser le sommaire
| Scénario | Recommandation |
|---|---|
| Document long (> 200 lignes) avec sommaire | Consulter 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: false | Ignorer 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
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ètre | Type | Obligatoire | Par défaut | Description |
|---|---|---|---|---|
doc_id | string | Oui | — | ID du document (issu des résultats de recherche) |
offset | number | Non | 1 | Numéro de ligne de départ (à partir de 1) |
limit | number | Non | 200 | Nombre de lignes à lire (maximum 500) |
output_format | string | Non | markdown | Définir sur json pour une sortie JSON structurée |
Format du contenu
L’outilRead retourne le contenu avec des numéros de ligne pour faciliter le référencement et le positionnement :
Stratégie de pagination
Pour les documents longs, il est recommandé de lire par blocs :read pour lire précisément cet intervalle.
Exemples d’utilisation
Exemples d’appels
Flux de travail complet : via CLI
L’exemple suivant illustre comment effectuer une recherche documentaire complète via le CLI :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 :Questions fréquentes
Quels formats de documents sont pris en charge ?
Quels formats de documents sont pris en charge ?
Linkly AI prend actuellement en charge les formats suivants :
| Format | Extension | Support du sommaire |
|---|---|---|
| Markdown | .md, .mdx | ✅ |
| Word | .docx | ✅ |
.pdf | Partiel | |
| Texte brut | .txt | ❌ |
| HTML | .html, .htm | Partiel |
Que faire si le sommaire n'est pas disponible ?
Que faire si le sommaire n'est pas disponible ?
Si le document n’a pas de sommaire disponible (
has_outline: false), vous pouvez :- Utiliser directement l’outil
readpour parcourir le contenu du document par pages - 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
Comment traiter les documents longs ?
Comment traiter les documents longs ?
Quel est le port par défaut du service MCP ?
Quel est le port par défaut du service MCP ?
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.
Que faire si les résultats de recherche sont imprécis ?
Que faire si les résultats de recherche sont imprécis ?
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
--typepour filtrer des types de documents spécifiques et affiner le champ de recherche


outline(si un sommaire est disponible)offsetetlimitdereadpour lire précisément les sections cibléesoffsetpour paginer