本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 开始使用
<a name="agent-tools-valkey-mcp-getting-started"></a>

## 安装
<a name="agent-tools-valkey-mcp-installation"></a>

**先决条件：**Python 3.10 或更高版本`uv`，访问 Valkey 数据存储库

**配置您的 MCP 客户端：**将以下内容添加到 MCP 客户端配置中：

```
{
  "mcpServers": {
    "valkey": {
      "command": "uvx",
      "args": ["awslabs.valkey-mcp-server@latest"],
      "env": {
        "VALKEY_HOST": "<your-endpoint>",
        "VALKEY_USE_SSL": "true"
      }
    }
  }
}
```

替换`<your-endpoint>`为 Valkey 数据存储库的终端节点。您的编码代理必须具有访问端点的网络权限。

**连接亚马逊 ElastiCache：** ElastiCache Valkey 集群位于私有 VPC 中，无法直接从您的本地计算机访问。有关 SSM 隧道设置、IAM 身份验证令牌生成以及隧道模式下的 TLS 处理，请参阅 AWS 代理工具包[中的](https://github.com/aws/agent-toolkit-for-aws/blob/main/skills/specialized-skills/database-skills/amazon-elasticache/references/setup/connection-guide.md)ElastiCache 连接指南，或安装 [ Amazon Sk ElastiCache ill 让您的代理端](agent-tools-skills.md)到端处理连接设置。建立隧道后，`VALKEY_HOST=127.0.0.1`在上面的配置中使用。

保存配置后重新启动 MCP 客户端。

您可以提示您的代理通过以下方式验证连接：

*使用 Valkey MCP 服务器验证与我的数据存储库的连接并确认 Valkey 操作可用。*

## 配置
<a name="agent-tools-valkey-mcp-configuration"></a>

通过 MCP 客户端配置中的环境变量配置 Valkey MCP 服务器。您也可以使用该`--readonly`标志将代理的访问权限限制为只读操作。


<table>
<thead>
  <tr><th>变量</th><th>用途</th></tr>
</thead>
<tbody>
  <tr><td><code>VALKEY_HOST</code></td><td>指定您的 Valkey 数据存储库的终端节点。通过隧道连接到私有 ElastiCache 集群<code>127.0.0.1</code>时使用。</td></tr>
  <tr><td><code>VALKEY_USE_SSL</code></td><td>设置为<code>true</code>以启用 TLS。对于启用了传输中加密的 ElastiCache 集群，这是必需的。</td></tr>
  <tr><td><code>--readonly</code></td><td>将服务器限制在读取层并禁用所有写入和管理工具，使其适合生产探索。</td></tr>
  <tr><td colspan="2"><b>可选搜索参数 </b></td></tr>
  <tr><td><code>EMBEDDINGS_PROVIDER</code></td><td>选择<code>add_documents</code>和使用的嵌入提供商<code>search</code>。支持的选项有<code>bedrock</code><code>openai</code>、<code>ollama</code>、和<code>hash</code>。无需凭证即可<code>hash</code>用于本地测试。</td></tr>
  <tr><td><code>BEDROCK_MODEL_ID</code></td><td>覆盖默认的亚马逊 Bedrock 嵌入模型。</td></tr>
  <tr><td><code>OPENAI_API_KEY</code></td><td>提供设置为时所需<code>EMBEDDING_PROVIDER</code>的 API 密钥<code>openai</code>。</td></tr>
</tbody>
</table>