Osim Mcp Server

by osim-group

158 downloads
Not rated
GitHub

About

OSIM MCP Server is a standardized MCP server implementation providing structured security data standards for AI applications.

Details

Author
osim-group
Downloads
158
Categories
Other

- Provides three MCP tools to list, describe, and retrieve schema definitions.
- Serves schema content via MCP resource URIs.
- Supports OSIM data standards: Alert, Asset, Log, Incident, Device Detection.
- Schema files are fetched from the OSIM Schema GitHub repository.
- Built on FastMCP and follows the Model Context Protocol specification.
- Can be run without installation via uvx from PyPI.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Osim Mcp Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Run instantly with uvx osim-mcp-server (no installation required) or clone the repository, execute python update_schemas.py to fetch schemas, then run uv sync && uv run python server.py. Configure the server in MCP clients such as Claude Desktop or Cursor by adding the command uvx osim-mcp-server to the client’s MCP settings. The server exposes three tools (list_schema_names, describe_schemas, get_schema) and resource URIs in the format data-standard://{group}/{category}/{title}.

list_schema_names

列出所有可用的数据标准 schema 名称。 返回对象列表,每个对象包含: - title: schema 名称,格式为 {group}.{category}.{title}(例如:log.network_session_audit.http_audit) - label: schema 的英文标签(来自 schema 文件) - label_{locale}: schema 的各语言标签(动态生成,根据 i18n 目录下的文件自动生成) 例如:如果存在 zh_CN.json,则会有 label_zh_CN 字段;如果存在 en_US.json,则会有 label_en_US 字段 如需获取描述,请使用 describe_schemas 工具。 Returns: List[Dict[str, Any]]: schema 信息列表,每个对象包含 title、label 和动态的 label_{locale} 字段

describe_schemas

获取指定 schema 名称列表的描述信息。 参数 schema_names 是 schema 名称列表,格式为 {group}.{category}.{title} (例如:["log.network_session_audit.http_audit", "alert.network_attack.apt_attack"])。 返回字典,键为 schema 名称,值为描述信息,方便理解应该使用哪个 schema。

get_schema

获取指定 schema 的字段定义。 参数 schema_path 格式为 {group}.{category}.{title} (例如:log.network_session_audit.http_audit),可以从 list_schema_names 中获取所有可用的 schema 名称。 返回字段定义字典,包含字段名、标签、类型、要求、描述等信息。

get_schema_version

获取当前 schemas 的版本信息。 返回包含本地版本号和更新状态的字典。 Returns: Dict[str, Any]: 包含 version(版本号)和 auto_update_enabled(是否启用自动更新)的字典

get_dictionaries

获取 dictionaries.json 文件内容。 返回 OSIM 数据标准中定义的字典项,包含字段名、标签、描述、类型等信息。 这些字典项定义了数据标准中使用的通用字段定义。 Returns: Dict[str, Any]: dictionaries.json 的完整内容,如果读取失败则返回包含错误信息的字典

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "osim mcp server": {
            "osim-mcp-server": {
                "command": "uvx",
                "args": [
                    "osim-mcp-server"
                ]
            }
        }
    }
}

McpServers

{
    "osim-mcp-server": {
        "command": "uvx",
        "args": [
            "osim-mcp-server"
        ]
    }
}

OSIM MCP Server

Python
FastMCP

基于 FastMCP 的 Model Context Protocol (MCP) 服务器,提供 OSIM (Open Security Information Model) 数据标准 schema 的查询和访问能力。

🚀 快速开始

使用 uvx(推荐,无需安装)

包已发布到 PyPI,可以直接使用 uvx 运行:

uvx osim-mcp-server

在 MCP 客户端中配置

Claude Desktop

在配置文件(~/Library/Application Support/Claude/claude_desktop_config.json)中添加:

{
  "mcpServers": {
    "osim-mcp-server": {
      "command": "uvx",
      "args": ["osim-mcp-server"]
    }
  }
}

Cursor

在 MCP 设置中添加:

{
  "mcpServers": {
    "osim-mcp-server": {
      "command": "uvx",
      "args": ["osim-mcp-server"]
    }
  }
}

从源码运行

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.