9524bfb270
This PR adds an MCP (Model Context Protocol ) server to LLDB. For motivation and background, please refer to the corresponding RFC: https://discourse.llvm.org/t/rfc-adding-mcp-support-to-lldb/86798 I implemented this as a new kind of plugin. The idea is that we could support multiple protocol servers (e.g. if we want to support DAP from within LLDB). This also introduces a corresponding top-level command (`protocol-server`) with two subcommands to `start` and `stop` the server. ``` (lldb) protocol-server start MCP tcp://localhost:1234 MCP server started with connection listeners: connection://[::1]:1234, connection://[127.0.0.1]:1234 ``` The MCP sever supports one tool (`lldb_command`) which executes a command, but can easily be extended with more commands.
101 lines
3.0 KiB
C++
101 lines
3.0 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 "Protocol.h"
|
|
#include "Tool.h"
|
|
#include "lldb/Core/ProtocolServer.h"
|
|
#include "lldb/Host/MainLoop.h"
|
|
#include "lldb/Host/Socket.h"
|
|
#include "llvm/ADT/StringMap.h"
|
|
#include <thread>
|
|
|
|
namespace lldb_private::mcp {
|
|
|
|
class ProtocolServerMCP : public ProtocolServer {
|
|
public:
|
|
ProtocolServerMCP(Debugger &debugger);
|
|
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::ProtocolServerSP CreateInstance(Debugger &debugger);
|
|
|
|
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
|
|
|
|
Socket *GetSocket() const override { return m_listener.get(); }
|
|
|
|
protected:
|
|
using RequestHandler = std::function<llvm::Expected<protocol::Response>(
|
|
const protocol::Request &)>;
|
|
using NotificationHandler =
|
|
std::function<void(const protocol::Notification &)>;
|
|
|
|
void AddTool(std::unique_ptr<Tool> tool);
|
|
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<protocol::Message>>
|
|
HandleData(llvm::StringRef data);
|
|
|
|
llvm::Expected<protocol::Response> Handle(protocol::Request request);
|
|
void Handle(protocol::Notification notification);
|
|
|
|
llvm::Expected<protocol::Response>
|
|
InitializeHandler(const protocol::Request &);
|
|
llvm::Expected<protocol::Response>
|
|
ToolsListHandler(const protocol::Request &);
|
|
llvm::Expected<protocol::Response>
|
|
ToolsCallHandler(const protocol::Request &);
|
|
|
|
protocol::Capabilities GetCapabilities();
|
|
|
|
llvm::StringLiteral kName = "lldb-mcp";
|
|
llvm::StringLiteral kVersion = "0.1.0";
|
|
|
|
Debugger &m_debugger;
|
|
|
|
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;
|
|
|
|
llvm::StringMap<RequestHandler> m_request_handlers;
|
|
llvm::StringMap<NotificationHandler> m_notification_handlers;
|
|
};
|
|
} // namespace lldb_private::mcp
|
|
|
|
#endif
|