networking: refactorization

Refactored comments and code

Signed-off-by: David Piskula <david.piskula@nxp.com>

Author: dpiskula-nxp

include/zephyr/net/mcp/mcp_server.h

@@ -7,6 +7,11 @@
 #ifndef ZEPHYR_INCLUDE_NET_MCP_SERVER_H_
 #define ZEPHYR_INCLUDE_NET_MCP_SERVER_H_
 
+/**
+ * @file
+ * @brief Model Context Protocol (MCP) Server API
+ */
+
 #include <zephyr/kernel.h>
 #include <errno.h>
 
@@ -15,6 +20,9 @@ extern "C" {
 #endif
 
 #ifdef CONFIG_MCP_TOOLS_CAPABILITY
+/**
+ * @brief Tool metadata structure
+ */
 typedef struct mcp_tool_metadata {
 	char name[CONFIG_MCP_TOOL_NAME_MAX_LEN];
 	char input_schema[CONFIG_MCP_TOOL_SCHEMA_MAX_LEN];
@@ -29,10 +37,18 @@ typedef struct mcp_tool_metadata {
 #endif
 } mcp_tool_metadata_t;
 
-/* Tool callback function signature */
+/**
+ * @brief Tool callback function
+ *
+ * @param params JSON string with tool parameters
+ * @param execution_token Unique execution identifier
+ * @return 0 on success, negative errno on failure
+ */
 typedef int (*mcp_tool_callback_t)(const char *params, uint32_t execution_token);
 
-/* Tool definition structure */
+/**
+ * @brief Tool definition structure
+ */
 typedef struct mcp_tool_record {
 	mcp_tool_metadata_t metadata;
 	mcp_tool_callback_t callback;
@@ -41,50 +57,48 @@ typedef struct mcp_tool_record {
 
 struct mcp_message_msg {
 	uint32_t token;
-	/* More fields will be added later */
 };
 
 /**
- * @brief Initialize the MCP Server.
+ * @brief Initialize the MCP Server
  *
- * @return 0 on success, negative errno code on failure
+ * @return 0 on success, negative errno on failure
  */
 int mcp_server_init(void);
 
 /**
- * @brief Start the MCP Server.
+ * @brief Start the MCP Server
  *
- * @return 0 on success, negative errno code on failure
+ * @return 0 on success, negative errno on failure
  */
 int mcp_server_start(void);
 
 /**
- * @brief Queues a response to the MCP Server library, which takes care of sending it to
- * the MCP Client.
+ * @brief Queue a response for delivery
  *
- * @return 0 on success, negative errno code on failure
+ * @return 0 on success, negative errno on failure
  */
 int mcp_queue_response(void);
 
 #ifdef CONFIG_MCP_TOOLS_CAPABILITY
 /**
- * @brief Add a tool to the MCP server tool registry
+ * @brief Add a tool to the server
  *
- * @param tool_record Pointer to tool record containing metadata and callback
- * @return 0 on success, negative errno code on failure
- *         -EINVAL if tool_record is NULL or invalid
- *         -EEXIST if tool with same name already exists
- *         -ENOSPC if tool registry is full
+ * @param tool_record Tool definition with metadata and callback
+ * @return 0 on success, negative errno on failure
+ * @retval -EINVAL Invalid tool_record
+ * @retval -EEXIST Tool name already exists
+ * @retval -ENOSPC Registry full
  */
 int mcp_server_add_tool(const mcp_tool_record_t *tool_record);
 
 /**
- * @brief Remove a tool from the MCP server tool registry
+ * @brief Remove a tool from the server
  *
- * @param tool_name Name of the tool to remove
- * @return 0 on success, negative errno code on failure
- *         -EINVAL if tool_name is NULL
- *         -ENOENT if tool not found
+ * @param tool_name Name of tool to remove
+ * @return 0 on success, negative errno on failure
+ * @retval -EINVAL Invalid tool name
+ * @retval -ENOENT Tool not found
  */
 int mcp_server_remove_tool(const char *tool_name);
 #endif

subsys/net/lib/mcp/mcp_common.h

@@ -29,11 +29,10 @@ typedef enum {
 	MCP_MSG_RESPONSE_TOOLS_CALL,
 #endif
 	MCP_MSG_NOTIFICATION,
-	/* unknown method, unknown tool, other errors */
 } mcp_queue_msg_type_t;
 
 typedef enum {
-	MCP_SYS_DISCONNECTION,
+	MCP_SYS_CLIENT_SHUTDOWN,
 	MCP_SYS_CANCEL
 } mcp_system_msg_type_t;
 
@@ -56,15 +55,12 @@ typedef enum {
 typedef struct mcp_system_msg {
 	mcp_system_msg_type_t type;
 	uint32_t request_id;
+	uint32_t client_id;
 } mcp_system_msg_t;
 
 typedef struct mcp_initialize_request {
 	uint32_t request_id;
 	uint32_t client_id;
-
-	/* MCP Core ignores client params and clientInfo and won't try
-	 * to use any client capabilities, in this implementation.
-	 */
 } mcp_initialize_request_t;
 
 #ifdef CONFIG_MCP_TOOLS_CAPABILITY
@@ -76,7 +72,6 @@ typedef struct mcp_tools_list_request {
 typedef struct mcp_tools_call_request {
 	uint32_t request_id;
 	uint32_t client_id;
-
 	char name[CONFIG_MCP_TOOL_NAME_MAX_LEN];
 	char arguments[CONFIG_MCP_TOOL_INPUT_ARGS_MAX_LEN];
 } mcp_tools_call_request_t;
@@ -109,26 +104,23 @@ typedef struct mcp_server_notification {
 	mcp_notification_method_type_t method;
 } mcp_server_notification_t;
 
-/* Queue message structures using void pointers */
 typedef struct mcp_request_queue_msg {
 	mcp_queue_msg_type_t type;
-	void *data; /* Points to allocated message data */
+	void *data;
 } mcp_request_queue_msg_t;
 
 typedef struct mcp_response_queue_msg {
 	mcp_queue_msg_type_t type;
-	void *data; /* Points to allocated message data */
+	void *data;
 } mcp_response_queue_msg_t;
 
 #ifdef CONFIG_MCP_TOOLS_CAPABILITY
-/* Tool registry structure */
 typedef struct {
 	mcp_tool_record_t tools[CONFIG_MCP_MAX_TOOLS];
 	struct k_mutex registry_mutex;
 	uint8_t tool_count;
 } mcp_tool_registry_t;
 
-/* Execution context for tracking active tool executions */
 typedef struct {
 	uint32_t execution_token;
 	uint32_t request_id;
@@ -141,26 +133,13 @@ typedef struct {
 	mcp_execution_state_t execution_state;
 } mcp_execution_context_t;
 
-/* Execution registry for tracking active executions */
 typedef struct {
 	mcp_execution_context_t executions[MCP_MAX_REQUESTS];
 	struct k_mutex execution_mutex;
 } mcp_execution_registry_t;
 #endif
 
-/**
- * @brief Allocate memory for MCP operations
- *
- * @param size Size in bytes to allocate
- * @return Pointer to allocated memory, or NULL on failure
- */
 void *mcp_alloc(size_t size);
-
-/**
- * @brief Free memory allocated by mcp_alloc()
- *
- * @param ptr Pointer to memory to free, or NULL (no-op if NULL)
- */
 void mcp_free(void *ptr);
 
 #endif /* ZEPHYR_SUBSYS_MCP_COMMON_H_ */