mcp_server.h

Go to the documentation of this file.

 
/*
 * Copyright 2025 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_MCP_SERVER_H_
#define ZEPHYR_INCLUDE_NET_MCP_SERVER_H_

 
#include <zephyr/kernel.h>
#include <errno.h>
 
#ifdef __cplusplus
extern "C" {
#endif

enum mcp_tool_msg_type {
        MCP_USR_TOOL_RESPONSE,          
        MCP_USR_TOOL_NOTIFICATION,      
        MCP_USR_TOOL_CANCEL_ACK,        
        MCP_USR_TOOL_PING               
};

enum mcp_tool_event_type {
        MCP_TOOL_CALL_REQUEST,  
        MCP_TOOL_CANCEL_REQUEST 
};

struct mcp_tool_metadata {
        char name[CONFIG_MCP_TOOL_NAME_MAX_LEN];                
        char input_schema[CONFIG_MCP_TOOL_SCHEMA_MAX_LEN];      
#ifdef CONFIG_MCP_TOOL_DESC
        char description[CONFIG_MCP_TOOL_DESC_MAX_LEN];         
#endif
#ifdef CONFIG_MCP_TOOL_TITLE
        char title[CONFIG_MCP_TOOL_NAME_MAX_LEN];               
#endif
#ifdef CONFIG_MCP_TOOL_OUTPUT_SCHEMA
        char output_schema[CONFIG_MCP_TOOL_SCHEMA_MAX_LEN];     
#endif
};

typedef void *mcp_server_ctx_t;

typedef int (*mcp_tool_callback_t)(enum mcp_tool_event_type event, const char *arguments,
                                   const char *execution_token);

struct mcp_tool_record {
        struct mcp_tool_metadata metadata;      
        atomic_t refcount;                                      
        mcp_tool_callback_t callback;           
};

struct mcp_tool_message {
        enum mcp_tool_msg_type type;    
        int length;                                             
        void *data;                                             
        bool is_error;                                  
};

mcp_server_ctx_t mcp_server_init(void);

int mcp_server_start(mcp_server_ctx_t server_ctx);

int mcp_server_submit_tool_message(mcp_server_ctx_t server_ctx,
                                   const struct mcp_tool_message *user_msg,
                                   const char *execution_token);

int mcp_server_add_tool(mcp_server_ctx_t server_ctx, const struct mcp_tool_record *tool_record);

int mcp_server_remove_tool(mcp_server_ctx_t server_ctx, const char *tool_name);

int mcp_server_is_execution_canceled(mcp_server_ctx_t server_ctx, const char *execution_token,
                                     bool *is_canceled);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_MCP_SERVER_H_ */