Paramus Extension API

Paramus Extension API#

Welcome to the Paramus Extension API documentation. This documentation covers the extension framework that provides dual access patterns for interacting with the Paramus system: JSON-RPC for external integration and direct Python for internal use.

Contents:

Quick Start#

The Paramus Extension Framework provides a dual-access API system with centralized command vocabulary. Choose the access method that best fits your use case:

  • JSON-RPC: For external integration, web clients, remote tools

  • Direct Python: For internal tools, AI agents, automation scripts

  • LangChain Tools: For AI agent integration with LangChain framework

JSON-RPC Access#

curl -X POST http://localhost:8050/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc": "2.0", "method": "copilot.test.hello", "id": 1}'

Direct Python Access#

from paramus.extension.api_surface.commands import extension_commands

# Get command registry and execute directly
registry = extension_commands.get_command_registry()
result = registry["copilot.test.hello"]()

LangChain Integration#

from paramus.extension.host.agent.copilot_tools import get_all_copilot_tools
from langchain.agents import initialize_agent

# Get tools for AI agent
tools = get_all_copilot_tools()
agent = initialize_agent(tools, llm, agent="zero-shot-react-description")

# Trigger UI actions
ui = UIBridge()
ui.trigger_new_button()
ui.send_notification("Operation completed!")

Indices and tables#

Contents