Tools Reference
Complete reference for all platform tools available via MCP
The Lovelace MCP server exposes the following tools. Each tool accepts a JSON input and returns structured results.
Workspace Tools
lovelace_list_workspaces
List all workspaces accessible to the authenticated user.
Input: None required
Output:
{
"workspaces": [
{
"id": "ws_abc123",
"name": "My Project",
"description": "Main development workspace",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-02-01T14:30:00Z"
}
]
}
lovelace_get_workspace
Get detailed information about a specific workspace.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | The workspace ID |
Example:
{
"workspaceId": "ws_abc123"
}
Output:
{
"id": "ws_abc123",
"name": "My Project",
"description": "Main development workspace",
"members": 3,
"agentCount": 2,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-02-01T14:30:00Z"
}
Agent Tools
lovelace_list_agents
List available agents and their current status.
Input: None required
Output:
{
"agents": [
{
"id": "agent_xyz789",
"name": "code-reviewer",
"status": "idle",
"description": "Reviews code for quality and security issues"
}
]
}
lovelace_spawn_agent
Spawn an agent to execute a task.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
agentId | string | Yes | The agent to spawn |
task | string | Yes | Task description for the agent |
workspaceId | string | No | Workspace context for the task |
config | object | No | Additional agent configuration |
Example:
{
"agentId": "code-reviewer",
"task": "Review the authentication module for security vulnerabilities",
"workspaceId": "ws_abc123"
}
Output:
{
"executionId": "exec_def456",
"agentId": "code-reviewer",
"status": "running",
"startedAt": "2025-02-17T12:00:00Z"
}
lovelace_get_agent_status
Check the execution status of a spawned agent.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
executionId | string | Yes | The execution ID returned by lovelace_spawn_agent |
Example:
{
"executionId": "exec_def456"
}
Output:
{
"executionId": "exec_def456",
"agentId": "code-reviewer",
"status": "completed",
"startedAt": "2025-02-17T12:00:00Z",
"completedAt": "2025-02-17T12:05:30Z",
"progress": 100
}
Status values: queued, running, completed, failed, cancelled
lovelace_get_agent_result
Retrieve the output and artifacts from a completed agent execution.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
executionId | string | Yes | The execution ID |
Example:
{
"executionId": "exec_def456"
}
Output:
{
"executionId": "exec_def456",
"status": "completed",
"output": "Found 3 potential security issues in the authentication module...",
"artifacts": [
{
"name": "security-report.md",
"type": "text/markdown",
"size": 4096
}
]
}
Knowledge Tools
lovelace_search_knowledge
Search the knowledge base for relevant documents.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search query |
limit | number | No | Maximum results (default: 10) |
workspaceId | string | No | Limit search to a specific workspace |
Example:
{
"query": "authentication best practices",
"limit": 5
}
Output:
{
"results": [
{
"id": "doc_ghi789",
"title": "Authentication Architecture",
"snippet": "Our authentication system uses OAuth 2.1 with PKCE...",
"score": 0.95,
"updatedAt": "2025-01-20T09:00:00Z"
}
],
"total": 12
}
lovelace_store_knowledge
Store a document in the knowledge base.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Document title |
content | string | Yes | Document content (Markdown supported) |
workspaceId | string | No | Workspace to store the document in |
tags | string[] | No | Tags for categorization |
Example:
{
"title": "API Rate Limiting Policy",
"content": "# Rate Limiting\n\nAll API endpoints enforce rate limits...",
"tags": ["api", "policy", "security"]
}
Output:
{
"id": "doc_jkl012",
"title": "API Rate Limiting Policy",
"createdAt": "2025-02-17T12:10:00Z"
}
Error Handling
All tools return errors in the standard MCP error format:
{
"content": [
{
"type": "text",
"text": "Error: Workspace not found"
}
],
"isError": true
}
Common error conditions:
| Error | Cause |
|---|---|
Workspace not found | The specified workspace ID does not exist or is not accessible |
Agent not found | The specified agent ID does not exist |
Execution not found | The specified execution ID does not exist |
Authorization required | Missing or invalid authentication token |
Insufficient permissions | Your token lacks the required scope |