使用说明(简要概览,便于快速落地)

  • 项目简介
    • ContextStream MCP Server 是一个完整的 MCP 服务端实现,负责向 MCP 客户端(如 Windsurf、Cursor、Claude Desktop、VS Code 等)提供标准化的资源、工具和提示模板管理,以及基于 JSON-RPC 的通信、会话管理与自动上下文注入能力。
  • 主要功能点
    • 资源管理:开放 API 文档、工作区与项目列表等资源读取。
    • 工具注册与执行:注册大量工具,支持按需调用、权限分级(Free/PRO)、以及自动上下文注入。
    • Prompts/Rule 模板:提供多种编辑器的规则模板生成与管理,以便将 ContextStream 的上下文能力嵌入到开发工作流中。
    • 会话管理与自动上下文:实现 First-Tool 拦截、会话初始化、上下文摘要注入,以及对工作区/项目的自动推断与缓存优化。
    • API 客户端与服务端耦合:内置 ContextStream 客户端,完成与 ContextStream API 的交互与数据缓存。
    • 多传输协议支持:通过 MCP Server 适配层,支持 StdIO 等传输方式,便于与不同客户端对接。
  • 安装步骤
    • 克隆仓库并安装依赖
    • 运行开发环境进行开发与本地调试
    • 如需快速试用:通过 npx @contextstream/mcp-server 即可启动服务器
  • 服务器配置(供 MCP 客户端使用的示例配置,描述性文字,不直接给出代码)
    • serverName: contextstream-mcp
    • command: npx
    • args: ["-y", "@contextstream/mcp-server"]
    • env 示例(需要提供 API 地址与鉴权信息):
      • CONTEXTSTREAM_API_URL: https://api.contextstream.io
      • CONTEXTSTREAM_API_KEY: 您的 API Key(若使用 JWT,请使用 CONTEXTSTREAM_JWT)
    • 说明:客户端连接时需提供以上参数以建立与 MCP 服务器的通信与鉴权;具体环境变量可按各客户端要求调整(如 VS Code、Cursor、Claude Desktop 等的 MCP 配置通常通过客户端的方式传递环境变量)。
  • 基本使用方法
    • 启动服务器
      • 使用本地开发环境:npx -y @contextstream/mcp-server(或全局安装后直接 contextstream-mcp)
    • 与 MCP 客户端对接
      • 在客户端的 MCP 配置中指定服务端命令、参数与所需环境变量(如 API URL、API Key/JWT)。
      • 客户端配置示例通常包含 server name、command、args、env 等字段,具体走客户端实现要求。
    • 使用流程(工具链)
      • 第一次对话:session_init(自动工作区/项目发现并加载上下文)
      • 后续对话:context_smart(在每次响应前注入相关上下文)
      • 任务完成后:session_capture(保存决策、偏好等信息)
  • 运行与开发注意
    • 服务器以 MCP JSON-RPC 的形式工作,确保客户端对接时遵循 RPC 约定
    • 本仓库还包含测试服务器、规则模板生成、工作区/本地配置、缓存等辅助模块,便于本地开发与集成测试

信息

分类

AI与计算