opensearch-skills

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

OpenSearch Skills

OpenSearch 技能

This is the top-level skill for OpenSearch. It contains three category skills that can also be installed and used independently:

Category	Skill	Install individually
search	opensearch-launchpad	`npx skills add opensearch-project/opensearch-agent-skills@opensearch-launchpad --full-depth`
observability	log-analytics	`npx skills add opensearch-project/opensearch-agent-skills@log-analytics --full-depth`
observability	trace-analytics	`npx skills add opensearch-project/opensearch-agent-skills@trace-analytics --full-depth`
cloud	aws-setup	`npx skills add opensearch-project/opensearch-agent-skills@aws-setup --full-depth`

这是OpenSearch的顶级技能，包含三个可独立安装和使用的分类技能：

分类	技能	独立安装命令
search	opensearch-launchpad	`npx skills add opensearch-project/opensearch-agent-skills@opensearch-launchpad --full-depth`
observability	log-analytics	`npx skills add opensearch-project/opensearch-agent-skills@log-analytics --full-depth`
observability	trace-analytics	`npx skills add opensearch-project/opensearch-agent-skills@trace-analytics --full-depth`
cloud	aws-setup	`npx skills add opensearch-project/opensearch-agent-skills@aws-setup --full-depth`

Routing

路由规则

Route to the right skill based on user intent:

User Intent	Skill
Build a search app, set up an index, choose a search strategy	opensearch-launchpad
Analyze logs, query with PPL, discover error patterns	log-analytics
Investigate traces, debug spans, analyze service maps	trace-analytics
Deploy to AWS, provision a domain or collection	aws-setup
General OpenSearch question	Search docs first, then route to the relevant skill

If the user's intent spans multiple skills (e.g., "build a search app and deploy it to AWS"), start with the appropriate skill and transition to the next when ready.

根据用户意图路由至对应技能：

用户意图	技能
构建搜索应用、设置索引、选择搜索策略	opensearch-launchpad
分析日志、用PPL查询、发现错误模式	log-analytics
追踪调查、调试跨度、分析服务映射	trace-analytics
部署至AWS、配置域或集合	aws-setup
OpenSearch通用问题	先搜索文档，再路由至相关技能

如果用户意图涉及多个技能（例如："构建搜索应用并部署至AWS"），先从对应技能开始，准备就绪后再切换至下一个技能。

Shared Resources

共享资源

All skills share these resources:

Scripts:
```
scripts/opensearch_ops.py
```
— CLI for all OpenSearch operations
Docker bootstrap:
```
scripts/start_opensearch.sh
```
— Start a local OpenSearch cluster
CLI Reference: cli-reference.md — Full command reference with examples
Search Builder UI:
```
scripts/ui/
```
— React frontend served on port 8765

bash

bash scripts/start_opensearch.sh
uv run python scripts/opensearch_ops.py <command> [options]
uv run python scripts/opensearch_ops.py --help

所有技能共享以下资源：

脚本：
```
scripts/opensearch_ops.py
```
—— 用于所有OpenSearch操作的CLI工具
Docker启动脚本：
```
scripts/start_opensearch.sh
```
—— 启动本地OpenSearch集群
CLI参考文档：cli-reference.md —— 包含示例的完整命令参考
搜索构建器UI：
```
scripts/ui/
```
—— 运行在8765端口的React前端

bash

bash scripts/start_opensearch.sh
uv run python scripts/opensearch_ops.py <command> [options]
uv run python scripts/opensearch_ops.py --help

Optional MCP Servers

可选MCP服务器

json

{
  "mcpServers": {
    "ddg-search": {
      "command": "uvx",
      "args": ["duckduckgo-mcp-server"]
    },
    "awslabs.aws-api-mcp-server": {
      "command": "uvx",
      "args": ["awslabs.aws-api-mcp-server@latest"],
      "env": { "FASTMCP_LOG_LEVEL": "ERROR" }
    },
    "aws-knowledge-mcp-server": {
      "command": "uvx",
      "args": ["fastmcp", "run", "https://knowledge-mcp.global.api.aws"],
      "env": { "FASTMCP_LOG_LEVEL": "ERROR" }
    },
    "opensearch-mcp-server": {
      "command": "uvx",
      "args": ["opensearch-mcp-server-py@latest"],
      "env": { "FASTMCP_LOG_LEVEL": "ERROR" }
    }
  }
}

json

{
  "mcpServers": {
    "ddg-search": {
      "command": "uvx",
      "args": ["duckduckgo-mcp-server"]
    },
    "awslabs.aws-api-mcp-server": {
      "command": "uvx",
      "args": ["awslabs.aws-api-mcp-server@latest"],
      "env": { "FASTMCP_LOG_LEVEL": "ERROR" }
    },
    "aws-knowledge-mcp-server": {
      "command": "uvx",
      "args": ["fastmcp", "run", "https://knowledge-mcp.global.api.aws"],
      "env": { "FASTMCP_LOG_LEVEL": "ERROR" }
    },
    "opensearch-mcp-server": {
      "command": "uvx",
      "args": ["opensearch-mcp-server-py@latest"],
      "env": { "FASTMCP_LOG_LEVEL": "ERROR" }
    }
  }
}

Auto-Installing Missing MCP Servers

自动安装缺失的MCP服务器

Before using any MCP tool, check if the server is available. If missing:

Locate the MCP config file:

Kiro:
```
.kiro/settings/mcp.json
```
Cursor:
```
.cursor/mcp.json
```
Claude Code:
```
.mcp.json
```
VS Code (Copilot):
```
.vscode/mcp.json
```
Windsurf:
```
~/.codeium/windsurf/mcp_config.json
```

Read the existing config (or start with
```
{"mcpServers": {}}
```
).
Merge in the missing server entry. Do not overwrite existing entries.
Save and inform the user to restart or reconnect MCP servers.

使用任何MCP工具前，检查服务器是否可用。若缺失：

找到MCP配置文件：

Kiro:
```
.kiro/settings/mcp.json
```
Cursor:
```
.cursor/mcp.json
```
Claude Code:
```
.mcp.json
```
VS Code (Copilot):
```
.vscode/mcp.json
```
Windsurf:
```
~/.codeium/windsurf/mcp_config.json
```

读取现有配置（或从
```
{"mcpServers": {}}
```
开始）。
合并缺失的服务器条目，不要覆盖现有条目。
保存并告知用户重启或重新连接MCP服务器。

Answering OpenSearch Knowledge Questions

回答OpenSearch知识类问题

bash

uv run python scripts/opensearch_ops.py search-docs --query "<your query>"
uv run python scripts/opensearch_ops.py search-docs --query "<query>" --site docs.aws.amazon.com

bash

uv run python scripts/opensearch_ops.py search-docs --query "<your query>"
uv run python scripts/opensearch_ops.py search-docs --query "<query>" --site docs.aws.amazon.com