使用说明（简要）

项目简介
- 该仓库实现了一个面向 LLM 的 MCP 服务器，用于提供 OSINT 平台的资源、工具和提示模板。服务器通过 MCP 协议与客户端通信，支持标准的 JSON-RPC 请求/响应格式，具备会话管理、能力声明以及多传输方式的基础能力（此实现以 Stdio 传输为主）。
- 服务器会对接 OSINT 平台 REST API，提供 60+ 种工具、Prompt 模板和静态资源，便于在对话中调用外部功能、读取数据、渲染提示等，提升 LLM 的上下文感知和执行能力。
主要功能点
- MCP 核心能力
  - Tool 列表查询：提供可用工具清单
  - Tool 调用：根据客户端请求执行对应工具并返回结果
  - Prompts：定义与渲染用于引导对话的模板
  - Resources：提供可读取的静态知识资源
- 与外部 API 的对接
  - OSINT API Client：封装对 OSINT 平台 REST API 的访问
  - 通过环境变量配置认证方式（JWT、API Key、Ory Kratos Headers）
- 安全与扩展
  - 支持会话与能力声明，便于在多模型/多客户端场景下协同工作
  - 通过命令行/配置驱动集成到 Claude 等客户端的工作流中
安装步骤
1. 克隆并进入项目：
  - 使用现有仓库的说明进行本地安装
2. 安装依赖并构建
  - 运行 npm install
  - 运行 npm run build（如需要编译 TypeScript）
3. 启动 MCP 服务器
  - 以本地开发模式运行，或按实际部署环境进行服务化部署
  - 服务器默认通过标准输入输出 (stdio) 进行 MCP 通信（打包后可改为其它传输模式）
服务器配置（供 MCP 客户端使用的必填信息） MCP 客户端在与本服务器建立连接时，至少需要提供以下配置以正确连接和认证。以下 JSON 示例描述了服务器的名称、启动命令及参数等信息，便于客户端在集成时使用。请注意，客户端实际使用时通常只需要启动命令及环境变量配置即可，本节仅作为配置示例说明，便于理解参数含义与用途。

{ "name": "osint-mcp-server", "command": "npx", "args": ["@osintukraine/mcp-server"], "env": { "OSINT_API_URL": "http://localhost:8000", "OSINT_JWT_TOKEN": "", // 如使用 JWT 暗钥认证，填入实际令牌 "OSINT_API_KEY": "", // 如使用 API Key 认证，填入实际密钥 "OSINT_ORY_USER_ID": "", // 使用 Ory Kratos 时的用户ID "OSINT_ORY_USER_EMAIL": "", // 使用 Ory Kratos 时的用户邮箱（可选） "OSINT_ORY_USER_ROLE": "authenticated" // 用户角色：authenticated 或 admin } }
配置字段说明
- name：服务器实例名称，便于在多服务器场景中标识
- command / args：启动 MCP 服务器的命令及参数，客户端通过这些信息启动并连接服务器
- env：环境变量，用于配置 API 基础地址、认证信息等
- 认证优先级（服务器端实现逻辑）
  1. JWT Token（OSINT_JWT_TOKEN）
  2. API Key（OSINT_API_KEY）
  3. Ory Kratos Headers（OSINT_ORY_USER_ID / OSINT_ORY_USER_EMAIL / OSINT_ORY_USER_ROLE）
基本使用方法
- 运行方式
  - 通过本地命令启动：使用服务端提供的启动命令和环境变量进行部署
- 调用方式
  - 客户端通过 MCP JSON-RPC 调用工具（ListTools、CallTool、ListPrompts、GetPrompt、ListResources、ReadResource 等）来获取工具列表、执行工具、获取提示、读取资源
- 运行前提
  - OSINT_API_URL 指向 OSINT 平台 REST API
  - 具备相应的认证信息（JWT/API Key/Ory Kratos）之一以通过安全认证
- 典型工作流
  - 客户端请求获取工具列表
  - 客户端选择 Tool 调用，传入名称与参数
  - 服务器执行对应逻辑，返回结构化结果给客户端
  - 客户端请求 Prompts 或 Resources 来获取模板与参考内容
关键信息
- 本实现为完整的 MCP 服务器端代码（非仅示例或客户端）。
- 提供了工具、提示、资源等 MCP 能力的完整入口，具备运行与对接能力，且包含对 OSINT API 的实装接口。
- 使用 Stdio 传输作为默认通信方式，便于在 Claude 等客户端中接入与测试。

关键词 OSINT, JSON-RPC, 向量检索, 实时分析, 情报平台
分类ID 5

关键词

使用说明（简要）

信息