llvm-project/lldb/source/Plugins/Protocol/MCP/ProtocolServerMCP.h
Jonas Devlieghere ed294c28ac
[lldb] Move MCP protocol into its own library (NFC) (#152059)
This PR moves the MCP protocol code into its own library
(`lldbProtocolMCP`) so the code can be shared between the
`ProtocolServerMCP` plugin in LLDB as well as `lldb-mcp`. The goal is to
do the same thing for DAP (which, for now, would be used exclusively
from `lldb-dap`).

To make it clear that it's neither part of the `lldb` nor the
`lldb_private` namespace, I created a new `lldb_protocol` namespace.

Depending on how much code would be reused by lldb-dap, we may move more
code into the protocol library.
2025-08-05 09:48:26 -07:00

111 lines
3.5 KiB
C++

//===- ProtocolServerMCP.h ------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_PLUGINS_PROTOCOL_MCP_PROTOCOLSERVERMCP_H
#define LLDB_PLUGINS_PROTOCOL_MCP_PROTOCOLSERVERMCP_H
#include "Resource.h"
#include "Tool.h"
#include "lldb/Core/ProtocolServer.h"
#include "lldb/Host/MainLoop.h"
#include "lldb/Host/Socket.h"
#include "lldb/Protocol/MCP/Protocol.h"
#include "llvm/ADT/StringMap.h"
#include <thread>
namespace lldb_private::mcp {
class ProtocolServerMCP : public ProtocolServer {
public:
ProtocolServerMCP();
virtual ~ProtocolServerMCP() override;
virtual llvm::Error Start(ProtocolServer::Connection connection) override;
virtual llvm::Error Stop() override;
static void Initialize();
static void Terminate();
static llvm::StringRef GetPluginNameStatic() { return "MCP"; }
static llvm::StringRef GetPluginDescriptionStatic();
static lldb::ProtocolServerUP CreateInstance();
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
Socket *GetSocket() const override { return m_listener.get(); }
protected:
using RequestHandler =
std::function<llvm::Expected<lldb_protocol::mcp::Response>(
const lldb_protocol::mcp::Request &)>;
using NotificationHandler =
std::function<void(const lldb_protocol::mcp::Notification &)>;
void AddTool(std::unique_ptr<Tool> tool);
void AddResourceProvider(std::unique_ptr<ResourceProvider> resource_provider);
void AddRequestHandler(llvm::StringRef method, RequestHandler handler);
void AddNotificationHandler(llvm::StringRef method,
NotificationHandler handler);
private:
void AcceptCallback(std::unique_ptr<Socket> socket);
llvm::Expected<std::optional<lldb_protocol::mcp::Message>>
HandleData(llvm::StringRef data);
llvm::Expected<lldb_protocol::mcp::Response>
Handle(lldb_protocol::mcp::Request request);
void Handle(lldb_protocol::mcp::Notification notification);
llvm::Expected<lldb_protocol::mcp::Response>
InitializeHandler(const lldb_protocol::mcp::Request &);
llvm::Expected<lldb_protocol::mcp::Response>
ToolsListHandler(const lldb_protocol::mcp::Request &);
llvm::Expected<lldb_protocol::mcp::Response>
ToolsCallHandler(const lldb_protocol::mcp::Request &);
llvm::Expected<lldb_protocol::mcp::Response>
ResourcesListHandler(const lldb_protocol::mcp::Request &);
llvm::Expected<lldb_protocol::mcp::Response>
ResourcesReadHandler(const lldb_protocol::mcp::Request &);
lldb_protocol::mcp::Capabilities GetCapabilities();
llvm::StringLiteral kName = "lldb-mcp";
llvm::StringLiteral kVersion = "0.1.0";
bool m_running = false;
MainLoop m_loop;
std::thread m_loop_thread;
std::unique_ptr<Socket> m_listener;
std::vector<MainLoopBase::ReadHandleUP> m_listen_handlers;
struct Client {
lldb::IOObjectSP io_sp;
MainLoopBase::ReadHandleUP read_handle_up;
std::string buffer;
};
llvm::Error ReadCallback(Client &client);
std::vector<std::unique_ptr<Client>> m_clients;
std::mutex m_server_mutex;
llvm::StringMap<std::unique_ptr<Tool>> m_tools;
std::vector<std::unique_ptr<ResourceProvider>> m_resource_providers;
llvm::StringMap<RequestHandler> m_request_handlers;
llvm::StringMap<NotificationHandler> m_notification_handlers;
};
} // namespace lldb_private::mcp
#endif