English Français العربية

com.korushield/koru-shield

السجل الرسمي البحث والويب

Manage Koru Shield DNS filtering: profiles, rules, categories, schedules, and logs.

الشيفرة المصدرية التوثيق

ماذا يمكنك أن تفعل مع com.korushield/koru-shield؟

  • "Block tiktok.com on the Kids profile"
  • "Would youtube.com be blocked on Kids right now?"
  • "Show me what got blocked today"
  • "Turn on adult content filtering for the whole house"
  • "Add a bedtime schedule 9pm to 7am on weekdays for the Kids profile"

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

Remote (streamable-http)
Claude Code 
claude mcp add --transport http koru-shield 'https://mcp.korushield.com/mcp'
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "koru-shield": {
            "type": "http",
            "url": "https://mcp.korushield.com/mcp"
        }
    }
}
NPM package korushield-mcp-server
Claude Code 
claude mcp add koru-shield -e 'KORU_SHIELD_API_KEY=<your koru_shield_api_key>' -- npx -y korushield-mcp-server@1.0.1
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "koru-shield": {
            "command": "npx",
            "args": [
                "-y",
                "korushield-mcp-server@1.0.1"
            ],
            "env": {
                "KORU_SHIELD_API_KEY": "<your koru_shield_api_key>"
            }
        }
    }
}

متغيرات البيئة

  • KORU_SHIELD_API_KEY إلزامي سري Your Koru Shield API key (create one in the dashboard at https://my.korushield.com under Settings > API Keys)

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. Koru Shield MCP Server
  2. What it does
  3. Setup
  4. Security notes
  5. Development
  6. License

Koru Shield MCP Server

Manage your Koru Shield DNS protection through AI assistants. Block domains, check policies, review blocked queries, manage schedules, and more, all through natural language.

What it does

Exposes your Koru Shield account as Model Context Protocol tools:

ToolWhat it does
list_profiles / get_profileList and inspect DNS protection profiles
create_rule / list_rules / delete_ruleBlock or allow domains per profile
list_filter_categories / set_filter_categoryToggle categories (adult, gambling, social media...)
simulate_policyCheck if a domain would be blocked right now
get_logsRecent DNS queries: allowed, blocked, when
analytics_summaryTotals, blocked percentage, encrypted queries
list_schedules / create_schedule / delete_scheduleTime windows (bedtime, homework hours)
list_devicesDevices enrolled per profile
get_entitlementsPlan, limits, current usage
get_referral_codeYour referral link

Example prompts once connected:

  • "Block tiktok.com on the Kids profile"
  • "Would youtube.com be blocked on Kids right now?"
  • "Show me what got blocked today"
  • "Turn on adult content filtering for the whole house"
  • "Add a bedtime schedule 9pm to 7am on weekdays for the Kids profile"

Setup

1. Get a Koru Shield API key

Sign in at https://my.korushield.com, go to API keys, and create one. Copy the key.

2. Install

No install needed. Run directly with npx:

npx -y korushield-mcp-server

Set your key as an environment variable:

export KORU_SHIELD_API_KEY="your-key-here"

Optional: KORU_SHIELD_API_URL overrides the API base URL (default https://my.korushield.com/api).

3. Connect your AI client

Claude Code

claude mcp add koru-shield -- npx -y korushield-mcp-server

(Claude Code passes environment through, so export KORU_SHIELD_API_KEY first. Or use the HTTP transport below with a header.)

Cursor / VS Code

Add to your MCP config (~/.cursor/mcp.json or VS Code mcp.json):

{
  "mcpServers": {
    "koru-shield": {
      "command": "npx",
      "args": ["-y", "korushield-mcp-server"],
      "env": {
        "KORU_SHIELD_API_KEY": "your-key-here"
      }
    }
  }
}

Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "koru-shield": {
      "command": "npx",
      "args": ["-y", "korushield-mcp-server"],
      "env": {
        "KORU_SHIELD_API_KEY": "your-key-here"
      }
    }
  }
}
HTTP transport (remote)

For clients that connect over HTTP (agents, hosted setups):

MCP_TRANSPORT=http PORT=3000 KORU_SHIELD_API_KEY="your-key-here" npx -y korushield-mcp-server

Or pass the key per-request instead of the env var:

POST https://your-host/mcp
Authorization: Bearer <koru-shield-api-key>

Health check: GET /healthz.

Security notes

  • Your API key grants full control of your Koru Shield account, including deleting rules and schedules. Treat it like a password.
  • Prefer a dedicated API key for AI assistants so you can revoke it independently.
  • The server never logs or transmits your key anywhere except to the Koru Shield API.

Development

npm install
npm run build
npm start

Test with the MCP Inspector:

KORU_SHIELD_API_KEY="your-key-here" npm run inspector

License

MIT

الأسئلة الشائعة

ما هو com.korushield/koru-shield؟

Manage Koru Shield DNS filtering: profiles, rules, categories, schedules, and logs.

كيف أثبّت com.korushield/koru-shield؟

يعمل كخادم بعيد. في Claude Code: claude mcp add --transport http koru-shield 'https://mcp.korushield.com/mcp'. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج com.korushield/koru-shield إلى مفتاح API؟

نعم. يتطلب KORU_SHIELD_API_KEY، وتضبطها في إعداداته.

هل com.korushield/koru-shield مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون com.korushield/koru-shield؟

ينشره KoruShield. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.