You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Searchand analyze Elastic documentation using the remote MCP server. Use this when the user asks to search docs, find documentation, check coherence, find inconsistencies, get a document by URL, or analyze document structure. Trigger words: search, find, docs, documentation, coherence, inconsistencies, related, structure, analyze.
3
+
description: Search, analyze, and author Elastic documentation using the remote MCP server. Use this when the user asks about Elastic product documentation, features, or APIs; wants to find, read, or verify existing docs pages; is writing or editing documentation; mentions cross-links between repos; asks about documentation structure, coherence, or consistency; wants to generate templates following Elastic content type guidelines; or references elastic.co/docs URLs or Elastic product names.
4
4
---
5
5
6
-
# Elastic Documentation MCP Search
6
+
# Elastic Documentation MCP
7
7
8
-
This skill provides access to Elastic documentation through a remote MCP server. Use these tools to search, analyze, and verify documentation content.
8
+
This skill provides access to Elastic documentation through a remote MCP server. Use these tools to search, analyze, author, and validate documentation content.
9
9
10
10
## Available Tools
11
11
12
12
### 1. SemanticSearch
13
13
14
-
**When to use:** User asks to search docs, find documentation, look up information, search for topics, find examples, or search Elastic documentation.
14
+
**When to use:** User asks about Elastic product features, needs to find existing docs pages, verify published content, or research what documentation exists on a topic.
**Trigger words:** search, find, docs, documentation, look up, examples, query, what docs, Elastic features
17
17
18
18
**Parameters:**
19
-
-`query` (required): The search query - can be a question or keywords
19
+
-`query` (required): The search query — can be a question or keywords
20
20
-`pageNumber` (optional, default: 1): Page number (1-based)
21
21
-`pageSize` (optional, default: 10, max: 50): Number of results per page
22
22
-`productFilter` (optional): Filter by product ID (e.g., 'elasticsearch', 'kibana', 'fleet', 'logstash')
@@ -28,9 +28,9 @@ This skill provides access to Elastic documentation through a remote MCP server.
28
28
29
29
### 2. FindRelatedDocs
30
30
31
-
**When to use:** User asks to find related docs, get related content, find similar documentation, get links, or find what to link to.
31
+
**When to use:** User wants to explore what documentation exists around a subject, build context for writing, or discover related content they should be aware of.
32
32
33
-
**Trigger words:** related, similar, links, content reuse, related documentation, see also
33
+
**Trigger words:** related, similar, links, content reuse, related documentation, see also, what else
34
34
35
35
**Parameters:**
36
36
-`topic` (required): Topic or search terms to find related documents for
@@ -43,9 +43,9 @@ This skill provides access to Elastic documentation through a remote MCP server.
43
43
44
44
### 3. CheckCoherence
45
45
46
-
**When to use:** User asks to verify document accuracy, check if content is accurate, validate documentation, check coherence, verify against docs, or ensure consistency across the documentation.
46
+
**When to use:** User wants to review documentation quality, audit coverage of a feature or concept, or check whether a topic is documented consistently across products and sections.
-`topic` (required): Topic or concept to check coherence for
@@ -63,7 +63,7 @@ This skill provides access to Elastic documentation through a remote MCP server.
63
63
64
64
### 4. FindInconsistencies
65
65
66
-
**When to use:** User asks to find inconsistencies, check for contradictions, find conflicts, compare documentation, or identify discrepancies between documents.
66
+
**When to use:** User wants to audit docs quality, verify that instructions don't contradict each other, or check for overlapping content within a product area.
@@ -80,12 +80,12 @@ This skill provides access to Elastic documentation through a remote MCP server.
80
80
81
81
### 5. GetDocumentByUrl
82
82
83
-
**When to use:** User provides a specific documentation URL or asks to get document, fetch page, retrieve doc by URL, or show a specific documentation page.
83
+
**When to use:** User provides an elastic.co/docs URL, references a known page, or you need the full content and metadata of a specific doc.
84
84
85
-
**Trigger words:** get document, fetch, URL, specific page, retrieve, show page
85
+
**Trigger words:** get document, fetch, URL, specific page, retrieve, show page, elastic.co
86
86
87
87
**Parameters:**
88
-
-`url` (required): The document URL(e.g., '/docs/elasticsearch/reference/index')
88
+
-`url` (required): The document URL. Accepts a full URL (e.g., `https://www.elastic.co/docs/deploy-manage/api-keys`) or a path (e.g., `/docs/deploy-manage/api-keys`). Query strings, fragments, and trailing slashes are ignored.
89
89
-`includeBody` (optional, default: false): Include full body content (set true for detailed analysis)
90
90
91
91
**Returns:** Full document content including:
@@ -101,12 +101,12 @@ This skill provides access to Elastic documentation through a remote MCP server.
101
101
102
102
### 6. AnalyzeDocumentStructure
103
103
104
-
**When to use:** User asks to analyze structure, check hierarchy, view document organization, see headings, or understand document layout.
104
+
**When to use:** User wants to evaluate page quality, check heading hierarchy, or assess AI enrichment status.
-`url` (required): The document URL to analyze. Accepts a full URL (e.g., `https://www.elastic.co/docs/deploy-manage/api-keys`) or a path (e.g., `/docs/deploy-manage/api-keys`). Query strings, fragments, and trailing slashes are ignored.
110
110
111
111
**Returns:** Structure analysis including:
112
112
- Heading count and list of headings
@@ -117,13 +117,121 @@ This skill provides access to Elastic documentation through a remote MCP server.
117
117
118
118
---
119
119
120
+
### 7. ResolveCrossLink
121
+
122
+
**When to use:** User references a cross-link, needs to verify a link target, or wants to know what anchors are available on a page.
-`crossLink` (required): The cross-link URI to resolve (e.g., `docs-content://get-started/intro.md`)
128
+
129
+
**Returns:** Resolved URL, repository, path, available anchors, and any fragment.
130
+
131
+
---
132
+
133
+
### 8. ListRepositories
134
+
135
+
**When to use:** User needs to know which repositories publish documentation or wants to explore the docs ecosystem.
136
+
137
+
**Trigger words:** list repos, repositories, available repos, cross-link index, docs ecosystem
138
+
139
+
**Parameters:** None
140
+
141
+
**Returns:** List of repositories with names, branches, paths, git refs, and last-updated timestamps.
142
+
143
+
---
144
+
145
+
### 9. GetRepositoryLinks
146
+
147
+
**When to use:** User wants to explore what a repository publishes, build a cross-link, or look up available anchor targets.
148
+
149
+
**Trigger words:** repository links, pages in repo, anchors, what does repo publish
150
+
151
+
**Parameters:**
152
+
-`repository` (required): The repository name (e.g., `docs-content`, `elasticsearch`)
153
+
154
+
**Returns:** Repository metadata, URL path prefix, page count, cross-link count, and a list of pages with their anchors.
155
+
156
+
---
157
+
158
+
### 10. FindCrossLinks
159
+
160
+
**When to use:** User wants to analyze inter-repository dependencies, check what links into or out of a repository, or audit cross-link usage.
161
+
162
+
**Trigger words:** find cross-links, links between repos, who links to, links from, dependencies
163
+
164
+
**Parameters:**
165
+
-`from` (optional): Source repository to find links from
166
+
-`to` (optional): Target repository to find links to
167
+
168
+
**Returns:** Count and list of cross-links with source repository, target repository, and the link URI.
169
+
170
+
---
171
+
172
+
### 11. ValidateCrossLinks
173
+
174
+
**When to use:** User wants to check link health, prepare a release, or diagnose broken cross-references.
175
+
176
+
**Trigger words:** validate cross-links, broken links, check links, link validation, link health
177
+
178
+
**Parameters:**
179
+
-`repository` (required): Target repository to validate links to (e.g., `docs-content`)
180
+
181
+
**Returns:** Valid link count, broken link count, and details of any broken links (source repo, link URI, errors).
182
+
183
+
---
184
+
185
+
### 12. ListContentTypes
186
+
187
+
**When to use:** User is deciding what type of page to create or asks about Elastic docs structure.
188
+
189
+
**Trigger words:** content types, what type, overview vs how-to, tutorial, troubleshooting, changelog type
190
+
191
+
**Parameters:** None
192
+
193
+
**Returns:** List of all content types (overview, how-to, tutorial, troubleshooting, changelog) with descriptions and when-to-use guidance.
194
+
195
+
---
196
+
197
+
### 13. GenerateTemplate
198
+
199
+
**When to use:** User wants to create a new documentation page, needs a starting point with correct frontmatter and structure, or asks for a template.
200
+
201
+
**Trigger words:** template, generate, starter, scaffold, new page, new doc
202
+
203
+
**Parameters:**
204
+
-`contentType` (required): One of `overview`, `how-to`, `tutorial`, `troubleshooting`, or `changelog`
205
+
-`title` (optional): Pre-fill the page or changelog title
206
+
-`description` (optional): Pre-fill the frontmatter description
207
+
-`product` (optional): Pre-fill the product field
208
+
209
+
**Returns:** A ready-to-use Markdown template (or YAML for changelogs) with correct frontmatter and structure.
210
+
211
+
---
212
+
213
+
### 14. GetContentTypeGuidelines
214
+
215
+
**When to use:** User is writing new content, reviewing existing pages against standards, or asks about Elastic docs best practices.
216
+
217
+
**Trigger words:** guidelines, best practices, how to write, checklist, evaluate, anti-patterns
218
+
219
+
**Parameters:**
220
+
-`contentType` (required): One of `overview`, `how-to`, `tutorial`, `troubleshooting`, or `changelog`
221
+
222
+
**Returns:** Detailed guidelines including required elements checklist, recommended sections, best practices, and anti-patterns for the content type.
223
+
224
+
---
225
+
120
226
## Usage Guidelines
121
227
122
-
1.**For general searches:** Start with `SemanticSearch` to find relevant documentation
123
-
2.**For content verification:** Use `CheckCoherence` to see how well a topic is documented
124
-
3.**For quality checks:** Use `FindInconsistencies` to identify potential documentation conflicts
125
-
4.**For specific pages:** Use `GetDocumentByUrl` when you have an exact URL
126
-
5.**For deep analysis:** Use `AnalyzeDocumentStructure` to understand page organization
228
+
1.**For general searches:** Start with `SemanticSearch` to find relevant documentation. Prefer this over a general web search for Elastic docs content.
229
+
2.**For content verification:** Use `CheckCoherence` to see how well a topic is documented.
230
+
3.**For quality checks:** Use `FindInconsistencies` to identify potential documentation conflicts.
231
+
4.**For specific pages:** Use `GetDocumentByUrl` when you have an exact URL.
232
+
5.**For deep analysis:** Use `AnalyzeDocumentStructure` to understand page organization.
233
+
6.**For cross-linking:** Use `ResolveCrossLink` to turn a cross-link URI into a real URL, `ListRepositories` to discover available repos, and `ValidateCrossLinks` to find broken links.
234
+
7.**For authoring:** Use `ListContentTypes` to pick the right type, `GenerateTemplate` to get a starter, and `GetContentTypeGuidelines` to write or evaluate content correctly.
0 commit comments