使用说明
项目简介
本项目是一个 MCP (Model Context Protocol) 服务器,它连接到 LlamaCloud 托管的知识库索引。通过此服务器,LLM 客户端可以使用 'get_information' 工具从您的 LlamaCloud 知识库中检索信息,从而增强 LLM 应用的上下文理解能力。
主要功能点
- 知识库信息检索: 提供 'get_information' 工具,允许 LLM 客户端通过提问查询 LlamaCloud 知识库,获取相关信息作为上下文。
- MCP 服务器: 实现了标准的 MCP 服务器协议,可以与任何兼容 MCP 协议的 LLM 客户端进行通信。
- LlamaCloud 集成: 无缝连接 LlamaCloud 托管的知识库索引,简化了知识库的接入流程。
安装步骤
- 安装依赖: 在项目根目录下,运行以下命令安装项目依赖。
npm install - 构建服务器: 运行以下命令编译 TypeScript 代码,生成可执行的 JavaScript 文件。
npm run build
服务器配置
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要编辑客户端的配置文件。以 Claude Desktop 为例,配置文件路径如下:
- MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
在配置文件中,添加或修改 'mcpServers' 部分,加入以下 JSON 配置。请务必根据实际情况修改以下配置中的路径和参数。
{ "mcpServers": { "llamacloud": { "command": "node", "args": [ "/path/to/llamacloud/build/index.js" ], "env": { "LLAMA_CLOUD_INDEX_NAME": "<YOUR_INDEX_NAME>", "LLAMA_CLOUD_PROJECT_NAME": "<YOUR_PROJECT_NAME>", "LLAMA_CLOUD_API_KEY": "<YOUR_API_KEY>" } } } }
配置参数说明:
- 'server name': 'llamacloud' - 服务器名称,可以自定义,用于在客户端中标识和引用此服务器。
- 'command': 'node' - 启动服务器的命令,表示使用 Node.js 运行时环境。
- 'args':
- '"/path/to/llamacloud/build/index.js"' - 服务器启动脚本的路径。请将 '"/path/to/llamacloud"' 替换为 您本地仓库 'run-llama_mcp-server-llamacloud' 目录的绝对路径。例如 '/Users/yourname/run-llama_mcp-server-llamacloud/build/index.js' (MacOS) 或 'C:\path\to\run-llama_mcp-server-llamacloud\build\index.js' (Windows)。
- 'env': 环境变量配置。
- 'LLAMA_CLOUD_INDEX_NAME': '<YOUR_INDEX_NAME>' - 替换为您的 LlamaCloud 索引名称。
- 'LLAMA_CLOUD_PROJECT_NAME': '<YOUR_PROJECT_NAME>' - 替换为您的 LlamaCloud 项目名称。
- 'LLAMA_CLOUD_API_KEY': '<YOUR_API_KEY>' - 替换为您的 LlamaCloud API 密钥。
基本使用方法
- 确保已正确安装和配置 MCP 客户端,例如 Claude Desktop。
- 确保已按照上述 服务器配置 步骤,将 LlamaCloud MCP 服务器添加到客户端配置中,并填写了正确的 LlamaCloud 凭据和索引信息。
- 启动 MCP 客户端。客户端应该能够自动连接到配置的 MCP 服务器。
- 在 LLM 客户端中,您可以使用 'get_information' 工具,并提供 'query' 参数来查询 LlamaCloud 知识库。客户端会将查询请求发送到 MCP 服务器,服务器会检索 LlamaCloud 知识库并将结果返回给客户端,作为 LLM 的上下文信息。
示例: 在 Claude Desktop 中,您可以指示 Claude 使用 'llamacloud' 服务器的 'get_information' 工具来回答问题。例如,您可以提问:'请使用 llamacloud 服务器的 get_information 工具,告诉我关于 {你的知识库主题} 的信息。'
信息
分类
数据库与文件