Skip to content

Commit e309f29

Browse files
authored
docs(mcp): add root llms.txt for MCP discovery; update MCP README to reference it; refs #76 (#91)
1 parent 0d9f92e commit e309f29

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ demo/experiment_results/**/*.json
2222
*.sh
2323
*.txt
2424
!CMakeLists.txt
25+
!llms.txt
2526
latency_breakdown*.json
2627
experiment_results/eval_results/diskann/*.json
2728
aws/

llms.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# llms.txt — LEANN MCP and Agent Integration
2+
product: LEANN
3+
homepage: https://github.com/yichuan-w/LEANN
4+
contact: https://github.com/yichuan-w/LEANN/issues
5+
6+
# Installation
7+
install: uv tool install leann-core --with leann
8+
9+
# MCP Server Entry Point
10+
mcp.server: leann_mcp
11+
mcp.protocol_version: 2024-11-05
12+
13+
# Tools
14+
mcp.tools: leann_list, leann_search
15+
16+
mcp.tool.leann_list.description: List available LEANN indexes
17+
mcp.tool.leann_list.input: {}
18+
19+
mcp.tool.leann_search.description: Semantic search across a named LEANN index
20+
mcp.tool.leann_search.input.index_name: string, required
21+
mcp.tool.leann_search.input.query: string, required
22+
mcp.tool.leann_search.input.top_k: integer, optional, default=5, min=1, max=20
23+
mcp.tool.leann_search.input.complexity: integer, optional, default=32, min=16, max=128
24+
25+
# Notes
26+
note: Build indexes with `leann build <name> --docs <files...>` before searching.
27+
example.add: claude mcp add --scope user leann-server -- leann_mcp
28+
example.verify: claude mcp list | cat

packages/leann-mcp/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Transform your development workflow with intelligent code assistance using LEANN's semantic search directly in Claude Code.
44

5+
For agent-facing discovery details, see `llms.txt` in the repository root.
6+
57
## Prerequisites
68

79
Install LEANN globally for MCP integration (with default backend):

0 commit comments

Comments
 (0)