Skip to content

Commit 14a8b3f

Browse files
committed
Merge branch 'main' into fix/test-elastic-nav
2 parents d45bd0d + 4edb626 commit 14a8b3f

966 files changed

Lines changed: 36145 additions & 5945 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/skills/mcp-search/SKILL.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
name: mcp-search
3+
description: Search and 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.
4+
---
5+
6+
# Elastic Documentation MCP Search
7+
8+
This skill provides access to Elastic documentation through a remote MCP server. Use these tools to search, analyze, and verify documentation content.
9+
10+
## Available Tools
11+
12+
### 1. SemanticSearch
13+
14+
**When to use:** User asks to search docs, find documentation, look up information, search for topics, find examples, or search Elastic documentation.
15+
16+
**Trigger words:** search, find, docs, documentation, look up, examples, query
17+
18+
**Parameters:**
19+
- `query` (required): The search query - can be a question or keywords
20+
- `pageNumber` (optional, default: 1): Page number (1-based)
21+
- `pageSize` (optional, default: 10, max: 50): Number of results per page
22+
- `productFilter` (optional): Filter by product ID (e.g., 'elasticsearch', 'kibana', 'fleet', 'logstash')
23+
- `sectionFilter` (optional): Filter by navigation section (e.g., 'reference', 'getting-started')
24+
25+
**Returns:** Search results with URLs, titles, descriptions, AI summaries, scores, and navigation context.
26+
27+
---
28+
29+
### 2. FindRelatedDocs
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.
32+
33+
**Trigger words:** related, similar, links, content reuse, related documentation, see also
34+
35+
**Parameters:**
36+
- `topic` (required): Topic or search terms to find related documents for
37+
- `limit` (optional, default: 10, max: 20): Maximum number of related documents to return
38+
- `productFilter` (optional): Filter by product ID
39+
40+
**Returns:** List of related documents with URLs, titles, descriptions, AI summaries, and relevance scores.
41+
42+
---
43+
44+
### 3. CheckCoherence
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.
47+
48+
**Trigger words:** verify, check, accurate, coherent, validate, consistency, coverage, align with docs
49+
50+
**Parameters:**
51+
- `topic` (required): Topic or concept to check coherence for
52+
- `limit` (optional, default: 20, max: 50): Maximum number of documents to analyze
53+
54+
**Returns:** Coherence analysis including:
55+
- Total documents covering the topic
56+
- Section coverage (how topic is spread across navigation sections)
57+
- Product coverage (which products document this topic)
58+
- AI enrichment status (docs with summaries)
59+
- Coverage score (0-100)
60+
- Top documents for the topic
61+
62+
---
63+
64+
### 4. FindInconsistencies
65+
66+
**When to use:** User asks to find inconsistencies, check for contradictions, find conflicts, compare documentation, or identify discrepancies between documents.
67+
68+
**Trigger words:** inconsistencies, contradictions, conflicts, discrepancies, compare, differences, overlaps
69+
70+
**Parameters:**
71+
- `topic` (required): Topic or concept to check for inconsistencies
72+
- `focusArea` (optional): Specific area to focus on (e.g., 'installation', 'configuration', 'api')
73+
74+
**Returns:** Analysis of potential inconsistencies including:
75+
- Documents that may have overlapping or conflicting content
76+
- Product breakdown showing document distribution
77+
- Pairs of documents that cover similar topics and may need review
78+
79+
---
80+
81+
### 5. GetDocumentByUrl
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.
84+
85+
**Trigger words:** get document, fetch, URL, specific page, retrieve, show page
86+
87+
**Parameters:**
88+
- `url` (required): The document URL (e.g., '/docs/elasticsearch/reference/index')
89+
- `includeBody` (optional, default: false): Include full body content (set true for detailed analysis)
90+
91+
**Returns:** Full document content including:
92+
- Title, URL, type, description
93+
- Navigation section and parent hierarchy
94+
- AI summaries (short summary and RAG-optimized summary)
95+
- AI-generated questions and use cases
96+
- Headings list
97+
- Product and related products
98+
- Body content (if includeBody=true)
99+
100+
---
101+
102+
### 6. AnalyzeDocumentStructure
103+
104+
**When to use:** User asks to analyze structure, check hierarchy, view document organization, see headings, or understand document layout.
105+
106+
**Trigger words:** structure, hierarchy, organization, headings, parents, layout, analyze
107+
108+
**Parameters:**
109+
- `url` (required): Document URL to analyze
110+
111+
**Returns:** Structure analysis including:
112+
- Heading count and list of headings
113+
- Link count
114+
- Parent count and parent hierarchy
115+
- Body length
116+
- AI enrichment status (has summary, has questions, has use cases)
117+
118+
---
119+
120+
## Usage Guidelines
121+
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
127+
128+
## Product IDs
129+
130+
Common product filters:
131+
- `elasticsearch` - Elasticsearch
132+
- `kibana` - Kibana
133+
- `fleet` - Fleet and Elastic Agent
134+
- `logstash` - Logstash
135+
- `beats` - Beats
136+
- `cloud` - Elastic Cloud
137+
- `ecs` - Elastic Common Schema
138+
- `apm` - APM
139+
- `security` - Elastic Security
140+
- `observability` - Elastic Observability

.cursorrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

.github/copilot-instructions.md

Lines changed: 0 additions & 193 deletions
This file was deleted.

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CLAUDE.md
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
# This workflow is used to build the MCP Lambda
3+
# lambda function bootstrap binary that can be deployed to AWS Lambda.
4+
name: Build MCP Lambda
5+
6+
on:
7+
workflow_dispatch:
8+
workflow_call:
9+
inputs:
10+
ref:
11+
required: false
12+
type: string
13+
default: ${{ github.ref }}
14+
15+
permissions:
16+
contents: read
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
env:
22+
BINARY_PATH: .artifacts/Elastic.Documentation.Mcp.Lambda/release_linux-x64/bootstrap
23+
steps:
24+
- uses: actions/checkout@v6
25+
with:
26+
ref: ${{ inputs.ref }}
27+
- name: Amazon Linux 2023 build
28+
run: |
29+
docker build . -t mcp-lambda:latest -f src/api/Elastic.Documentation.Mcp.Lambda/Dockerfile
30+
- name: Get bootstrap binary
31+
run: |
32+
docker cp $(docker create --name tc mcp-lambda:latest):/app/.artifacts/publish ./.artifacts && docker rm tc
33+
- name: Inspect bootstrap binary
34+
run: |
35+
tree .artifacts
36+
stat "${BINARY_PATH}"
37+
- name: Archive artifact
38+
id: upload-artifact
39+
uses: actions/upload-artifact@v6
40+
with:
41+
name: mcp-lambda-binary
42+
retention-days: 1
43+
if-no-files-found: error
44+
path: ${{ env.BINARY_PATH }}

0 commit comments

Comments
 (0)