Inkog MCP Server

关键词

AI 安全平台工具注册与执行MLBOM 生成AGENTS.md 审核A2A 安全

Inkog MCP Server 使用说明

一、项目简介

  • 这是一个基于 MCP 的后端服务器实现，作为面向 LLM 客户端的上下文服务层，负责托管资源、注册并执行工具、以及定义/渲染提示模板，提供统一的 JSON-RPC 接口供客户端调用。

二、主要功能点

  • 资源与工具管理：托管工具定义、注册、执行工具调用，返回 MCP 兼容的内容格式。
  • 工具集合：当前内置工具包括 inkog_scan、inkog_verify_governance、inkog_compliance_report、inkog_explain_finding、inkog_audit_mcp_server、inkog_generate_mlbom、inkog_audit_a2a 等，覆盖安全扫描、治理验证、合规报告、漏洞解释、MCP 服务器审计、MLBOM 生成、A2A 审计等场景。
  • Prompts/模板能力：通过可渲染的输出结构，向 MCP 客户端返回格式化文本内容或资源数据（文本、图片等）。
  • 传输与协议：MCP 基础的 JSON-RPC 通信，底层传输通过 Stdio（标准输入输出）等方式实现，便于与本地和嵌入式客户端集成。
  • 会话与安全：接入 Inkog 的 API 服务实现对接、日志等级控制、以及基础的错误/异常处理。

三、安装步骤

  1. 安装依赖与构建
  • 安装依赖并构建服务器后即可运行。通常步骤包括：
    • 安装依赖
    • 构建产物
    • 启动服务
  1. 启动方式
  • 运行通过 Node.js 启动的 MCP 服务器。启动后服务器会通过标准输入/输出（Stdio）传输方式与 MCP 客户端进行通信。

四、服务器配置（MCP 客户端连接所需） 服务器端配置用于 MCP 客户端启动和连接。以下描述适用于 MCP 客户端在本地或集成环境中如何启动 Inkog 的 MCP 服务器进程以接入你的应用。配置信息以 JSON 格式提供，包含 server name、command、args 等字段（仅用于客户端启动该服务器，实际通信由 MCP 协议完成）。请将以下信息填入你的 MCP 客户端配置中。

{ "serverName": "inkog", "serverVersion": "1.0.0", "command": "npx", "args": ["-y", "@inkog-io/mcp"], "env": { "INKOG_API_KEY": "<your_api_key>" } // 说明： // - serverName 与 serverVersion 对应代码中的默认值，前者用于在 MCP 客户端识别服务器，后者用于对外展示。 // - command/args 指定启动服务器所需的命令和参数，示例与 README 提供的一致，确保 MCP 客户端能通过该命令启动服务器进程。 // - env 如需调用 Inkog API，需要设置 INKOG_API_KEY，为保护 API 调用所必需的鉴权 token。 // - MCP 客户端不需要额外的服务器端实现细节，只需确保该启动配置可正确启动 Inkog 的 MCP 服务器进程。 }

五、基本使用方法

  • 启动服务器后，MCP 客户端即可通过 JSON-RPC 请求 ListTools 获取工具列表，通过 CallTool 请求执行具体工具。
  • 调用示例（简要描述，不包含实际代码）：
    • 获取工具列表：请求类型为 ListTools，返回工具数组及各自的描述、输入结构等信息。
    • 调用工具：通过 CallTool 请求，传入工具名称和参数，服务器返回工具执行结果的文本或图片等内容，以及错误标志。
  • 常用工具清单：inkog_scan、inkog_verify_governance、inkog_compliance_report、inkog_explain_finding、inkog_audit_mcp_server、inkog_generate_mlbom、inkog_audit_a2a。

六、运行与调试

  • 参与环境：需要具备 Node.js 环境、Inkog API 的访问权限并配置有效的 INKOG_API_KEY。
  • 日志与调试：根据需要在配置中设置 logLevel 为 debug，可获得详细的调试日志输出。
  • 兼容性：服务器实现遵循 MCP 的工具/资源/提示等模型，与 MCP 客户端标准交互。

七、注意事项

  • API KEY 安全性：请勿在公开环境暴露 INKOG_API_KEY，建议使用受限环境变量管理方式。
  • 资源与工具的扩展：如需新增工具，可在 src/tools 下实现并在 src/tools/index.ts 注册，以扩展 MCP 服务能力。
  • 依赖版本：请使用与项目兼容的 MCP SDK 版本，确保与客户端约定的请求/响应格式保持一致。

七、快速体验步骤

  • 准备一个 MCP 客户端配置，指向 Inkog 的 MCP 服务器启动命令。
  • 在客户端配置中填入服务器名称与可执行命令，确保能够自动启动服务。
  • 使用 ListTools 调用查看支持的工具，随后逐步调用具体工具完成任务。

注：以上使用说明基于仓库提供的实现与 README 中的示例信息整理，实际部署时请结合具体环境配置和依赖版本进行调整。

服务器信息

访问项目