feat(ui+backend): complete Bulk Import implementation (200 cap) by vk-playground · Pull Request #798 · IBM/mcp-context-forge

vk-playground · 2025-08-21T00:37:11Z

Original ticket PR #739 only delivered modal wiring and documented a draft schema; this PR completes the UI to match the finalized backend. It delivers end-to-end support for importing multiple tools via JSON file upload or paste, enforcing validation rules, and handling partial success cases.

Key Changes

Frontend (admin.html / JS)

Added Bulk Import modal with:

Drag-and-drop JSON file upload support.

- JSON paste input with real-time debounce validation.

Backend

Endpoint: POST /admin/tools/import
Authentication: Admin only, JWT-based.
Rate limiting: 10 requests/minute.
Transaction-safe batch persistence with rollback support.

{
  "success": true,
  "created_count": 2,
  "failed_count": 0,
  "created": [{"index":0,"name":"tool_1"},{"index":1,"name":"tool_2"}],
  "errors": []
}

Configuration

Environment variables required:

export MCPGATEWAY_UI_ENABLED=true
export MCPGATEWAY_ADMIN_API_ENABLED=true
export BASIC_AUTH_USER=admin
export BASIC_AUTH_PASSWORD=admin
export JWT_SECRET_KEY=my-test-key
export MCPGATEWAY_BULK_IMPORT_ENABLED="true"

Validation Rules

Tool name must start with a letter and contain only alphanumeric or underscores.
Required fields: name, url, description.
Optional fields: integration type, request type, tags, headers, auth.
Maximum: 200 tools per batch.
File format supported: JSON array only.

Testing Scenarios

Successful batch import of 10 tools. Ex:

[
  {
    "name": "Tool_A",
    "url": "https://api.example.com/alpha",
    "description": "Alpha test tool for bulk import",
    "integration_type": "REST",
    "request_type": "GET",
    "tags": ["alpha", "test", "api"]
  },
  {
    "name": "Tool_B",
    "url": "https://api.example.com/beta",
    "description": "Beta test tool for bulk import",
    "integration_type": "REST",
    "request_type": "POST",
    "tags": ["beta", "import"]
  },
  {
    "name": "Tool_C",
    "url": "https://service.example.com/gamma",
    "description": "Gamma service integration",
    "integration_type": "MCP",
    "request_type": "GET",
    "headers": { "Accept": "application/json" }
  },
  {
    "name": "Tool_D",
    "url": "http://localhost:8080/delta",
    "description": "Local delta tool for testing",
    "integration_type": "REST",
    "request_type": "POST"
  },
  {
    "name": "Tool_E",
    "url": "https://tools.example.com/epsilon",
    "description": "Epsilon tool description",
    "integration_type": "REST",
    "request_type": "GET",
    "tags": ["epsilon", "utility"]
  },
  {
    "name": "Tool_F",
    "url": "https://api.example.com/zeta",
    "description": "Zeta bulk import test",
    "integration_type": "REST",
    "request_type": "POST",
    "auth": { "type": "basic", "username": "user", "password": "pass" }
  },
  {
    "name": "Tool_G",
    "url": "https://service.example.com/eta",
    "description": "Eta example service",
    "integration_type": "MCP",
    "request_type": "GET"
  },
  {
    "name": "Tool_H",
    "url": "https://tools.example.com/theta",
    "description": "Theta integration tool",
    "integration_type": "REST",
    "request_type": "POST",
    "tags": ["theta", "integration", "api"]
  },
  {
    "name": "Tool_I",
    "url": "https://api.example.com/iota",
    "description": "Iota test API tool",
    "integration_type": "REST",
    "request_type": "GET"
  },
  {
    "name": "Tool_J",
    "url": "https://service.example.com/kappa",
    "description": "Kappa service test tool",
    "integration_type": "REST",
    "request_type": "POST",
    "tags": ["kappa", "test"]
  }
]

Invalid JSON syntax error handling.
Duplicate name rejection.
Partial success when some tools are invalid.
Import rate limit enforcement.

Signed-off-by: Vicky Kuo <vicky.kuo.contact@gmail.com>

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

crivetimihai · 2025-08-21T10:33:21Z

Review and rebase in progress, please do not make further changes.

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

crivetimihai

Rebased, merged, tested

rakdutta

PR Testing Summary

make serve – ✅ Pass
make test – ✅ Pass (75%, 2135 passed, 15 skipped, 599 warnings in 194.55s)
make autoflake isort black flake8 – ✅ No errors
make pylint – ✅ Pass (Your code has been rated at 10.00/10)
make smoketest – ✅ Pass (Smoketest passed!)
make doctest – ✅ Pass (45%, 491 passed, 6 skipped, 68 warnings in 29.17s)

✅ Bulk Import functionality is working fine.

Tests Performed

Paste JSON option – Verified with example JSON input.
Upload file option – Verified with example JSON file.
Existing tool name – Tested handling of duplicate tool names.
Invalid tool names – Tested cases where the tool name starts with a number, contains only numbers, or includes special characters.

Example JSON contained 10 tools, but only 8 tools were successfully registered.

Observations

Missing Tools – Tools such as Tool_C and Tool_H were not registered, and no error message was displayed.
Error Handling – Integrity errors (e.g., duplicate name) are not surfaced in the UI.
Validation Errors – Validation issues are not consistently shown in the UI or backend logs.
Registration Summary – UI does not display the number of tools successfully registered.
Unregistered Tool Details – Tools that fail to register should provide error details (both in UI and logs) so users can identify which tools failed and why, and developers can analyze the root cause later.
Add Server, Add Gateway, and Add Tool – All functionalities are working as expected.

) * fix(ui/bulk-import): align UI with bulk import API Signed-off-by: Vicky Kuo <vicky.kuo.contact@gmail.com> * Rebase Signed-off-by: Mihai Criveti <crivetimihai@gmail.com> * Fix HTML Signed-off-by: Mihai Criveti <crivetimihai@gmail.com> --------- Signed-off-by: Vicky Kuo <vicky.kuo.contact@gmail.com> Signed-off-by: Mihai Criveti <crivetimihai@gmail.com> Co-authored-by: Vicky <vicky.kuo.contact@gmail.com> Co-authored-by: Mihai Criveti <crivetimihai@gmail.com>

vk-playground requested a review from crivetimihai as a code owner August 21, 2025 00:37

vk-playground force-pushed the main branch from 969d876 to 3a876d7 Compare August 21, 2025 00:48

Vicky and others added 2 commits August 21, 2025 10:15

fix(ui/bulk-import): align UI with bulk import API

c2451fd

Signed-off-by: Vicky Kuo <vicky.kuo.contact@gmail.com>

Rebase

cecb224

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

crivetimihai force-pushed the main branch from 3a876d7 to cecb224 Compare August 21, 2025 10:28

Fix HTML

06d3b9f

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

rakdutta assigned rakdutta and unassigned rakdutta Aug 21, 2025

crivetimihai requested a review from rakdutta August 21, 2025 11:05

crivetimihai approved these changes Aug 21, 2025

View reviewed changes

rakdutta reviewed Aug 21, 2025

View reviewed changes

crivetimihai merged commit 7edc4fc into IBM:main Aug 21, 2025
36 checks passed

rakdutta mentioned this pull request Aug 21, 2025

[CHORE][UI]: Bulk import missing error messages and feedback #806

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ui+backend): complete Bulk Import implementation (200 cap)#798

feat(ui+backend): complete Bulk Import implementation (200 cap)#798
crivetimihai merged 3 commits intoIBM:mainfrom
vk-playground:main

vk-playground commented Aug 21, 2025

Uh oh!

crivetimihai commented Aug 21, 2025

Uh oh!

crivetimihai left a comment

Uh oh!

rakdutta left a comment •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

vk-playground commented Aug 21, 2025

Key Changes

Frontend (admin.html / JS)

Backend

Configuration

Validation Rules

Testing Scenarios

Uh oh!

crivetimihai commented Aug 21, 2025

Uh oh!

crivetimihai left a comment

Choose a reason for hiding this comment

Uh oh!

rakdutta left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

PR Testing Summary

Tests Performed

Observations

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rakdutta left a comment •

edited

Loading