Fix Tool Edit Screen: Field Mapping Consistency and Custom Tool Naming Implementation #786

rakdutta · 2025-08-19T07:21:51Z

Overview

This PR resolves issue #715 by implementing custom tool naming functionality and fixing field mapping inconsistencies in the tool edit screen. The changes improve the user experience by distinguishing between MCP and REST tool editing capabilities while maintaining backward compatibility.

Key Features

🔹 Custom Tool Naming

New custom_name field: Allows users to set display names independent of original MCP server tool names
Database migration: Safely transitions from original_name_slug → custom_name / custom_name_slug fields
Auto-population: Defaults custom_name to original_name if not explicitly provided
Slug generation: Automatically creates URL-safe custom_name_slug for internal routing

🔹 Enhanced Tool Edit Logic

MCP Tools (Read-only constraints):

URL field is read-only (cannot modify MCP server endpoints)
Headers, input schema, and auth fields are disabled
Integration type cannot be changed from MCP → REST
Prevents invalid configuration changes

REST Tools (Full editing):

All fields remain editable with validation
URLs, headers, schemas, and authentication are modifiable
Integration type can be changed between REST variants

🔹 UI/UX Improvements

Field validation for custom names using existing security patterns
Clear visual feedback for read-only vs editable fields
Alerts for invalid operations (e.g., REST → MCP conversion)
Hidden name field maintains API compatibility while displaying customName to users

Technical Details

Database Changes

ALTER TABLE tools DROP COLUMN original_name_slug;
ALTER TABLE tools ADD COLUMN custom_name VARCHAR;
ALTER TABLE tools ADD COLUMN custom_name_slug VARCHAR;

API Schema Updates

# ToolUpdate now supports custom naming
class ToolUpdate(BaseModel):
    name: Optional[str] = Field(None, description="Unique name for the tool")
    custom_name: Optional[str] = Field(None, description="Custom name for the tool")
    # ... other fields

# ToolRead includes both custom and computed names
class ToolRead(BaseModel):
    custom_name: str
    custom_name_slug: str
    # ... other fields

Frontend Logic

Tracks integration type changes to prevent invalid transitions
Dynamically enables/disables fields based on tool type
Provides immediate user feedback

Backward Compatibility

Migration strategy: Existing tools auto-populate custom_name_slug from original_name_slug
API compatibility: Extends functionality while keeping endpoints unchanged
Form handling: Hidden fields ensure submissions work with existing backend logic

Testing

Verified functionality through both the UI and API endpoints.

Signed-off-by: RAKHI DUTTA <[email protected]>

* Add logging UI Signed-off-by: Mihai Criveti <[email protected]> * Add logging UI Signed-off-by: Mihai Criveti <[email protected]> * Add logging UI Signed-off-by: Mihai Criveti <[email protected]> * Add logging UI readme Signed-off-by: Mihai Criveti <[email protected]> * Update logging flake8 Signed-off-by: Mihai Criveti <[email protected]> * Update logging flake8 Signed-off-by: Mihai Criveti <[email protected]> * test coverage Signed-off-by: Mihai Criveti <[email protected]> * test coverage Signed-off-by: Mihai Criveti <[email protected]> * Fix download Signed-off-by: Mihai Criveti <[email protected]> * Fix test Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

* Fix download Signed-off-by: Mihai Criveti <[email protected]> * Reverse proxy Signed-off-by: Mihai Criveti <[email protected]> * Reverse proxy Signed-off-by: Mihai Criveti <[email protected]> * Reverse proxy Signed-off-by: Mihai Criveti <[email protected]> * doctest improvements Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

Signed-off-by: Ian Molloy <[email protected]>

* Fix rpc endpoints Signed-off-by: Madhav Kandukuri <[email protected]> * Remove commented code Signed-off-by: Madhav Kandukuri <[email protected]> * remove duplicate code in session registry Signed-off-by: Madhav Kandukuri <[email protected]> * Linting fixes Signed-off-by: Madhav Kandukuri <[email protected]> * Fix tests Signed-off-by: Madhav Kandukuri <[email protected]> --------- Signed-off-by: Madhav Kandukuri <[email protected]>

* Fix tool invocation 'Invalid method' error with backward compatibility (IBM#753) - Add backward compatibility for direct tool invocation (pre-PR IBM#746 format) - Support both old format (method=tool_name) and new format (method=tools/call) - Add comprehensive test coverage for RPC tool invocation scenarios - Ensure graceful fallback to gateway forwarding when method is not a tool The RPC endpoint now handles tool invocations in both formats: 1. New format: method='tools/call' with name and arguments in params 2. Old format: method='tool_name' with params as arguments (backward compat) This maintains compatibility with existing clients while supporting the new standardized RPC method structure introduced in PR IBM#746. Signed-off-by: Mihai Criveti <[email protected]> * Fix flake8 E722: Replace bare except with Exception Signed-off-by: Mihai Criveti <[email protected]> * lint Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

IBM#755) - Added nosec B105 for ENV_TOKEN as it's an environment variable name, not a hardcoded secret - Added nosec B110 for intentional exception swallowing in cleanup/error handling paths - Both cases are legitimate uses where errors should be silently ignored to prevent cascading failures Signed-off-by: Mihai Criveti <[email protected]>

Signed-off-by: Mihai Criveti <[email protected]>

Signed-off-by: Vinod Muthusamy <[email protected]> Co-authored-by: Vinod Muthusamy <[email protected]>

Signed-off-by: Mihai Criveti <[email protected]>

* Implement comprehensive fuzz testing automation (IBM#256) - Add property-based testing with Hypothesis for JSON-RPC, JSONPath, and schema validation - Add coverage-guided fuzzing with Atheris for deep code path exploration - Add API endpoint fuzzing with Schemathesis for contract validation - Add security-focused testing for vulnerability discovery (SQL injection, XSS, etc.) - Add complete Makefile automation with fuzz-all, fuzz-quick, fuzz-extended targets - Add optional [fuzz] dependency group in pyproject.toml for clean installation - Add comprehensive reporting with JSON/Markdown outputs and executive summaries - Add complete developer documentation with examples and troubleshooting guides - Exclude fuzz tests from main test suite to prevent auth failures - Found multiple real bugs in JSON-RPC validation during development Signed-off-by: Mihai Criveti <[email protected]> * Update fuzz testing Signed-off-by: Mihai Criveti <[email protected]> * Update fuzz testing Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

* Update CORS Signed-off-by: Mihai Criveti <[email protected]> * Update CORS Signed-off-by: Mihai Criveti <[email protected]> * Update CORS ADRs Signed-off-by: Mihai Criveti <[email protected]> * Update CORS Signed-off-by: Mihai Criveti <[email protected]> * Update CORS Signed-off-by: Mihai Criveti <[email protected]> * Fix compose Signed-off-by: Mihai Criveti <[email protected]> * Update helm chart Signed-off-by: Mihai Criveti <[email protected]> * Update CORS docs Signed-off-by: Mihai Criveti <[email protected]> * Update test Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

* feat: Bulk Import Tools modal wiring and backend implementation - Add modal UI in admin.html with bulk import button and dialog - Implement modal open/close/ESC functionality in admin.js - Add POST /admin/tools/import endpoint with rate limiting - Support both JSON textarea and file upload inputs - Validate JSON structure and enforce 200 tool limit - Return detailed success/failure information per tool - Include loading states and comprehensive error handling Refs IBM#737 Signed-off-by: Mihai Criveti <[email protected]> * fix: Remove duplicate admin_import_tools function and fix HTML formatting - Remove duplicate admin_import_tools function definition - Fix HTML placeholder attribute to use double quotes - Add missing closing div tag - Fix flake8 blank line issues Signed-off-by: Mihai Criveti <[email protected]> * feat: Complete bulk import backend with file upload support and enhanced docs - Add file upload support to admin_import_tools endpoint - Fix response format to match frontend expectations - Add UI usage documentation with modal instructions - Update API docs to show all three input methods - Enhance bulk import guide with UI and API examples Backend improvements: - Support tools_file form field for JSON file uploads - Proper file content parsing with error handling - Response includes imported/failed counts and details - Frontend-compatible response format for UI display Signed-off-by: Mihai Criveti <[email protected]> * Bulk import Signed-off-by: Mihai Criveti <[email protected]> * fix: Remove conflicting inline script and fix bulk import functionality - Remove conflicting inline JavaScript that was preventing form submission - Fix indentation in setupBulkImportModal function - Ensure bulk import modal uses proper admin.js implementation - Restore proper form submission handling for bulk import This fixes the issue where bulk import appeared to do nothing. Signed-off-by: Mihai Criveti <[email protected]> * fix: Integrate bulk import setup with main initialization - Add setupBulkImportModal() to main initialization sequence - Remove duplicate DOMContentLoaded listener - Ensure bulk import doesn't interfere with other tab functionality Signed-off-by: Mihai Criveti <[email protected]> * fix: JavaScript formatting issues in bulk import modal - Fix multiline querySelector formatting - Fix multiline Error constructor formatting - Ensure prettier compliance for web linting Signed-off-by: Mihai Criveti <[email protected]> * debug: Temporarily disable bulk import setup to test tabs Signed-off-by: Mihai Criveti <[email protected]> * fix: Remove duplicate setupFormValidation call and delay bulk import setup - Remove duplicate setupFormValidation() call that could cause conflicts - Use setTimeout to delay bulk import modal setup after other initialization - Add better null safety to form element queries - This should fix tab switching issues Signed-off-by: Mihai Criveti <[email protected]> * fix: Restore proper initialization sequence for tab functionality - Remove setTimeout delay for bulk import setup - Keep bulk import setup in main initialization but with error handling - Ensure tab navigation isn't affected by bulk import modal setup Signed-off-by: Mihai Criveti <[email protected]> * fix: Correct HTML structure and restore tab navigation - Move bulk import modal to correct location after tools panel - Remove extra closing div that was breaking HTML structure - Ensure proper page-level modal placement - Restore tab navigation functionality for all tabs This fixes the broken Global Resources, Prompts, Gateways, Roots, and Metrics tabs. Signed-off-by: Mihai Criveti <[email protected]> * feat: Add configurable bulk import settings Configuration additions: - MCPGATEWAY_BULK_IMPORT_MAX_TOOLS (default: 200) - MCPGATEWAY_BULK_IMPORT_RATE_LIMIT (default: 10) Implementation: - config.py: Add new settings with defaults - admin.py: Use configurable rate limit and batch size - .env.example: Document all bulk import environment variables - admin.html: Use dynamic max tools value in UI text - CLAUDE.md: Document configuration options for developers - docs: Update bulk import guide with configuration details This makes bulk import fully configurable for different deployment scenarios. Signed-off-by: Mihai Criveti <[email protected]> * Update docs Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]> Co-authored-by: Mihai Criveti <[email protected]>

Signed-off-by: Mihai Criveti <[email protected]>

* Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export Signed-off-by: Mihai Criveti <[email protected]> * Import export testing Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

Signed-off-by: Frederico Araujo <[email protected]>

Signed-off-by: Mihai Criveti <[email protected]>

* Metadata / creation dates Signed-off-by: Mihai Criveti <[email protected]> * Metadata / creation dates Signed-off-by: Mihai Criveti <[email protected]> * Metadata / creation dates Signed-off-by: Mihai Criveti <[email protected]> * Security headers CSP Signed-off-by: Mihai Criveti <[email protected]> * Display metadata for resources Signed-off-by: Madhav Kandukuri <[email protected]> * eslint fix Signed-off-by: Madhav Kandukuri <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]> Co-authored-by: Madhav Kandukuri <[email protected]>

Signed-off-by: Mihai Criveti <[email protected]>

* Fix annotations edit Signed-off-by: Mihai Criveti <[email protected]> * Fix annotations edit Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

* feat: update context forge target in template's project dependencies Signed-off-by: Frederico Araujo <[email protected]> * fix: exclude jinja files from reformatting tabs Signed-off-by: Frederico Araujo <[email protected]> * fix: plugins cli defaults Signed-off-by: Frederico Araujo <[email protected]> * fix: revert formatted Makefile template Signed-off-by: Frederico Araujo <[email protected]> * feat: add optional packages Signed-off-by: Frederico Araujo <[email protected]> * docs: update plugin template docs Signed-off-by: Frederico Araujo <[email protected]> * docs: update template readme Signed-off-by: Frederico Araujo <[email protected]> --------- Signed-off-by: Frederico Araujo <[email protected]>

Signed-off-by: RAKHI DUTTA <[email protected]>

madhav165

Works as expected.

Added tools with MCP server
Updated tool name from edit tool box
Tool shows with updated name in gateway and other clients like MCP Inspector and tool works.

GOOD TO MERGE.

@rakdutta Do we need to allow editing name in update_tool function in tool_service?

Signed-off-by: Mihai Criveti <[email protected]>

crivetimihai

Rebased and tested

rakdutta · 2025-08-21T10:31:52Z

@madhav165
Raised PR #805
to remove name update logic from tool_service.py

rakdutta1 and others added 30 commits August 14, 2025 18:03

db.py update

705a1cb

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

b57c0fd

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

a76bf1e

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

53e3bb2

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

d109e29

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

9cd14d4

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

b21583f

Signed-off-by: RAKHI DUTTA <[email protected]>

doc test

eb6b499

Signed-off-by: RAKHI DUTTA <[email protected]>

pytest

fb982d0

Signed-off-by: RAKHI DUTTA <[email protected]>

pytest

476b4b6

Signed-off-by: RAKHI DUTTA <[email protected]>

revert alembic with main version

a61a1e0

Signed-off-by: RAKHI DUTTA <[email protected]>

(fix) Added missing prompts/get (IBM#748)

d566c62

Signed-off-by: Ian Molloy <[email protected]>

Add agents file

1c27f57

Signed-off-by: Mihai Criveti <[email protected]>

pylint (IBM#759)

b73023d

Signed-off-by: Mihai Criveti <[email protected]>

Remove redundant title in readme. (IBM#757)

53fd0f8

Signed-off-by: Vinod Muthusamy <[email protected]> Co-authored-by: Vinod Muthusamy <[email protected]>

Update documentation with fixed image tag

89fac0e

Signed-off-by: Mihai Criveti <[email protected]>

Implemented configuration export (IBM#764)

dfaafe6

Signed-off-by: Mihai Criveti <[email protected]>

fix: local network address translation in discovery module (IBM#767)

1d5746f

Signed-off-by: Frederico Araujo <[email protected]>

Well known (IBM#770)

67390a7

Signed-off-by: Mihai Criveti <[email protected]>

Update docs with jsonrpc tutorial (IBM#772)

263f170

Signed-off-by: Mihai Criveti <[email protected]>

crivetimihai and others added 18 commits August 19, 2025 14:45

Fix pre-commit hooks

4221c43

Signed-off-by: Mihai Criveti <[email protected]>

744 annotations (IBM#784)

36b5717

* Fix annotations edit Signed-off-by: Mihai Criveti <[email protected]> * Fix annotations edit Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>

edit-tool

e8e03d1

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

7dbde16

Signed-off-by: RAKHI DUTTA <[email protected]>

doc test

a9edb9e

Signed-off-by: RAKHI DUTTA <[email protected]>

edit-tool

e915674

Signed-off-by: RAKHI DUTTA <[email protected]>

Merge branch 'main' into fix-715

2184a41

web lint

a7b2ae6

Signed-off-by: RAKHI DUTTA <[email protected]>

flake8 fix

ee313e1

Signed-off-by: RAKHI DUTTA <[email protected]>

pytest fix

48ec9d6

Signed-off-by: RAKHI DUTTA <[email protected]>

revert with main

a01d49d

Signed-off-by: RAKHI DUTTA <[email protected]>

flake fix

3c62bde

Signed-off-by: RAKHI DUTTA <[email protected]>

revert with main

6ba26c3

Signed-off-by: RAKHI DUTTA <[email protected]>

alembic

ad64796

Signed-off-by: RAKHI DUTTA <[email protected]>

alembic change

2cd54e8

Signed-off-by: RAKHI DUTTA <[email protected]>

flake8 fix

2461d7d

Signed-off-by: RAKHI DUTTA <[email protected]>

remove addtional line

af2f19e

Signed-off-by: RAKHI DUTTA <[email protected]>

rakdutta changed the title ~~Fix Tool Edit Screen: Field Mapping Consistency and implement edit logic for MCP tools~~ Fix Tool Edit Screen: Field Mapping Consistency and Custom Tool Naming Implementation Aug 20, 2025

alembic

b77992b

Signed-off-by: RAKHI DUTTA <[email protected]>

rakdutta marked this pull request as ready for review August 20, 2025 06:36

rakdutta requested review from crivetimihai, kevalmahajan and madhav165 as code owners August 20, 2025 06:36

madhav165 approved these changes Aug 20, 2025

View reviewed changes

crivetimihai added 2 commits August 20, 2025 18:56

Merge remote-tracking branch 'origin/main' into fix-715

31c8f5c

Rebase and fix

7ab9290

Signed-off-by: Mihai Criveti <[email protected]>

crivetimihai approved these changes Aug 20, 2025

View reviewed changes

crivetimihai merged commit df217a1 into IBM:main Aug 20, 2025
36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix Tool Edit Screen: Field Mapping Consistency and Custom Tool Naming Implementation #786

Fix Tool Edit Screen: Field Mapping Consistency and Custom Tool Naming Implementation #786

Uh oh!

rakdutta commented Aug 19, 2025 •

edited

Loading

Uh oh!

madhav165 left a comment •

edited

Loading

Uh oh!

crivetimihai left a comment

Uh oh!

Uh oh!

rakdutta commented Aug 21, 2025

Uh oh!

Uh oh!

Fix Tool Edit Screen: Field Mapping Consistency and Custom Tool Naming Implementation #786

Fix Tool Edit Screen: Field Mapping Consistency and Custom Tool Naming Implementation #786

Uh oh!

Conversation

rakdutta commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Key Features

🔹 Custom Tool Naming

🔹 Enhanced Tool Edit Logic

🔹 UI/UX Improvements

Technical Details

Database Changes

API Schema Updates

Frontend Logic

Backward Compatibility

Testing

Uh oh!

madhav165 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

Uh oh!

crivetimihai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rakdutta commented Aug 21, 2025

Uh oh!

Uh oh!

rakdutta commented Aug 19, 2025 •

edited

Loading

madhav165 left a comment •

edited

Loading