Back to MCP directory
publicPublicdnsLocal runtime

inkeep_mcp-server-python

Inkeep MCP服务器项目,基于Python开发,通过Inkeep平台提供的RAG技术管理和检索产品文档内容。

article

README

🚀 mcp-server-python

mcp-server-python 是一个可借助你的文档和产品内容运行的 Inkeep MCP 服务器,为你提供便捷的 RAG 功能。

🚀 快速开始

✨ 主要特性

  • 借助 Inkeep 账户管理并提供 RAG 功能。
  • 依赖 uv Python 项目管理器进行项目管理。

📦 安装指南

依赖项

  • 需拥有 Inkeep 账户以管理并提供 RAG 功能(Inkeep)。
  • 需安装 uv Python 项目管理器。

本地设置

git clone https://github.com/inkeep/mcp-server-python.git
cd mcp-server-python
uv venv
uv pip install -r pyproject.toml

⚠️ 重要提示

注意项目的完整路径,后续步骤中将引用此路径为<YOUR_INKEEP_MCP_SERVER_ABSOLUTE_PATH>

💻 使用示例

获取 API 密钥

  1. 登录Inkeep 仪表盘
  2. 转到项目部分并选择你的项目。
  3. 打开集成选项卡。
  4. 点击创建集成并选择API选项。
  5. 为新的 API 集成输入一个名称。
  6. 点击创建
  7. 出现一个生成的API 密钥,可用于认证 API 请求。

⚠️ 重要提示

我们将在后续步骤中将此密钥引用为<YOUR_INKEEP_API_KEY>

添加到你的 MCP 客户端

按照这个指南设置 Claude Desktop。

在你的claude_desktop_config.json文件中,向mcpServers部分添加以下内容:

{
    "mcpServers": {
        "inkeep-mcp-server": {
            "command": "uv",
            "args": [
                "--directory",
                "<YOUR_INKEEP_MCP_SERVER_ABSOLUTE_PATH>",
                "run",
                "-m",
                "inkeep_mcp_server"
            ],
            "env": {
                "INKEEP_API_BASE_URL": "https://api.inkeep.com/v1",
                "INKEEP_API_KEY": "<YOUR_INKEEP_API_KEY>",
                "INKEEP_API_MODEL": "inkeep-rag",
                "INKEEP_MCP_TOOL_NAME": "search-product-content",
                "INKEEP_MCP_TOOL_DESCRIPTION": "检索 Inkeep 的产品文档。查询应以关于 Inkeep 的对话形式提出。"
            }
        },
    }
}

💡 使用建议

你可能需要在 command 字段中放置 uv 可执行文件的完整路径。你可以通过运行which uv(MacOS/Linux)或where uv(Windows)来获取此路径。

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client