vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/api/mcp_server_get_detail.py.dox.md
Alessandro ab34084069 Polish MCP server management UI 
Revamp the global and project MCP manager surfaces with list-first layout, clearer examples, a dedicated scanner modal, manager/raw toolbar parity, and local-command-first server creation.\n\nAdd server and tool search, plugin-style enable toggles, per-tool disabled_tools handling in the MCP backend, internal A0 MCP tool search, regression coverage, and updated DOX contracts.
2026-06-11 03:01:19 +02:00

2.4 KiB
Raw Permalink Blame History

mcp_server_get_detail.py DOX

Purpose

  • Own the mcp_server_get_detail.py API endpoint.
  • This module handles MCP server detail requests for global or project scope.
  • Keep this file-level DOX profile synchronized with mcp_server_get_detail.py because this directory is intentionally flat.

Ownership

  • mcp_server_get_detail.py owns the runtime implementation.
  • mcp_server_get_detail.py.dox.md owns durable notes about responsibilities, contracts, side effects, and verification for that implementation.
  • Classes:
  • McpServerGetDetail (ApiHandler)
    • async process(self, input: dict[Any, Any], request: Request) -> dict[Any, Any] | Response

Runtime Contracts

  • HTTP handlers must derive from helpers.api.ApiHandler; WebSocket handlers must derive from helpers.ws.WsHandler.
  • The request accepts server_name and optional project_name; when project_name is present, detail resolves through the project-scoped MCP configuration.
  • Detail responses include the server tools visible to the manager UI. Tools disabled through a server disabled_tools config list remain present in this detail list with a disabled flag so the UI can re-enable them.
  • Update this file whenever request payloads, authentication or CSRF requirements, response shapes, route side effects, or WebSocket event contracts change.
  • McpServerGetDetail is an ApiHandler.
  • McpServerGetDetail defines process(...).
  • Imported dependency areas include: helpers.api, helpers.mcp_handler, typing.

Key Concepts

  • Important called helpers/classes observed in the source: MCPConfig.get_instance.get_server_detail, MCPConfig.get_project_instance, MCPConfig.get_instance.
  • Keep request/response, tool, or helper semantics documented here at the same time as source changes.

Work Guidance

  • Preserve authentication, CSRF, loopback, and API-key checks unless the endpoint contract explicitly changes.
  • Update frontend callers, plugin callers, and tests together when payload shape changes.
  • Use helpers.api.Response for non-JSON responses, files, redirects, or status-specific replies.

Verification

  • Run endpoint-specific or API/WebSocket tests for changed behavior; smoke-test browser callers when no focused test exists.
  • No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check.

Child DOX Index

No child DOX files.