Lcontext MCP 服务器

使用说明(Markdown 格式)

  • 项目简介

    • Lcontext MCP 服务器按照 Model Context Protocol(MCP)提供标准化的上下文服务,能够托管与管理行为分析相关的资源(页面、元素、访客、会话等),注册并执行 Tools,渲染 Prompts。服务器通过 JSON-RPC 方式与客户端通信,支持通过标准输入输出(STDIO)等传输方式实现与 LM 客户端的安全、高效对接。
  • 主要功能点

    • 提供以下工具(Tools)供 LLM 调用:
      • get_page_context:获取某页面在给定时间范围内的全量上下文(页面信息、统计、交互元素等)。
      • list_pages:列出被跟踪的页面。
      • get_element_context:获取指定页面中某个元素的上下文信息。
      • get_app_context:应用层面的统计与洞察(如会话、访客、页面视图等)。
      • get_visitors、get_visitor_detail:访客列表及单个访客详情。
      • get_sessions、get_session_detail:会话列表及单个会话详情。
    • 支持多种传输方式(当前实现为 STDIO 传输,便于与 MCP 客户端在同一进程树中集成)。通过环境变量进行 API 认证与可选 API 基地址配置。
    • 内部实现包含自更新检查、输入验证、数据格式化为易于理解的文本报告等特性,以便将分析结果直观地提供给 LM 客户端。
    • 对外通过一个统一的 API 代理层调用 Lcontext 的后端数据接口,生成结构化文本报告(包含页面、元素、访客、会话等的汇总、明细以及 AI 洞察)。
  • 安装步骤(本仓库以源码形式提供 MCP 服务器实现;也提供可执行二进制的快速安装路径)

    • 通过源码运行(常见场景)
      1. 安装 Node.js 和相关依赖(如 npm/yarn)。
      2. 克隆仓库并进入目录。
      3. 安装依赖并构建:
        • npm install
        • npm run build
      4. 设置运行时所需的环境变量:
        • LCONTEXT_API_KEY: 你的 Lcontext API 密钥(必填)。
        • LCONTEXT_API_URL: API 基地址(可选,默认为 https://lcontext.com)。
      5. 启动服务器(服务器实现基于 STDIO 传输,通常由 MCP 客户端在启动时以子进程形式连接); 该 MCP 服务器实现会通过 STDIO 与客户端通信,接收 JSON-RPC 请求并返回响应。
    • 快速安装(使用二进制/CLI 安装)
      • 官方提供的快速安装脚本可下载一个独立二进制(lcontext-mcp),可直接作为 MCP 服务器运行环境。安装后可按 client 的需要通过配置进行集成。
    • 配置要求
      • MCP 客户端在连接此服务器时需要提供服务器的启动配置(包含命令和参数等)来创建对接。以下描述为配置示例(非代码块形式),用于帮助理解:
        • server name: lcontext-mcp
        • command: lcontext-mcp
        • args: []
        • 环境变量(运行时必填/可选)
          • LCONTEXT_API_KEY: 你的 Lcontext API KEY(必填,后端用于鉴权)
          • LCONTEXT_API_URL: API 基地址,默认 https://lcontext.com
  • 服务器配置(MCP 客户端连接需要的配置信息描述)

    • 配置示例(JSON 格式描述,非代码块) { "server": { "name": "lcontext-mcp", "command": "lcontext-mcp", "args": [] }, "environment": { "LCONTEXT_API_KEY": "your-api-key", "LCONTEXT_API_URL": "https://lcontext.com" } }
    • 配置说明
      • server.name:MCP 服务器在客户端侧的标识名,与服务器实现中的名称一致以确保正确识别。
      • server.command:启动 MCP 服务器的命令(此处为 lcontext-mcp,官方提供的独立二进制)。
      • server.args:启动时的参数;当前实现在 STDIO 传输下不强制额外参数,留空即可,若未来需要自定义启动参数可在此处添加。
      • environment:服务器运行所需的环境变量,核心为 LCONTEXT_API_KEY,确保客户端能够通过 API Key 访问后端数据。
  • 基本使用方法

    • 客户端工作流:MCP 客户端(如你的 LM 驱动环境)通过 JSON-RPC 调用定义的 Tool(如 get_page_context、get_visitors 等)来获取上下文与分析结果。服务器返回格式化后的文本报告,便于将上下文信息整合到对话或工作流中。
    • 运行后端后,客户端需按照 MCP 的标准流程启动并通过标准输入输出建立通信通道,随后就可以调用上述 Tools。
    • 常见问题与排错
      • 未设置 LCONTEXT_API_KEY 会导致所有 API 请求失败,请确保已正确设置。
      • API URL 未设置时使用默认 https://lcontext.com。

服务器信息