Skip to main content

Interface

Connection Functions

connect(config, options?)

Create a generic DirectClient.

connectOpenAI(config, options?)

Create a client with OpenAI tool formatting.

connectClaude(config, options?)

Create a client with Anthropic Claude formatting.

connectVercelAI(config, options?)

Create a client with Vercel AI SDK formatting.

Connection Options

Tool Operations

listTools()

List all available tools with platform-specific formatting.

callTool(name, args?)

Execute a tool and get platform-formatted result.

Resource Operations

listResources()

List all static resources. Every page is fetched (a FrontMCP server pages its lists 40 at a time by default), so the result never carries a nextCursor.

readResource(uri)

Read a resource by URI.

listResourceTemplates()

List all resource templates, following every page like listResources().

Prompt Operations

listPrompts()

List all prompts, following every page like listResources().

getPrompt(name, args?)

Get a prompt with arguments.

Skill Operations

searchSkills(query, options?)

Search for skills.

loadSkills(skillIds, options?)

Load skills into the session.

listSkills(options?)

List all available skills.

Job Operations

listJobs(options?)

List all available jobs.

executeJob(name, input?, options?)

Execute a job by name. Supports background mode.

getJobStatus(runId)

Get the status of a job run.

Workflow Operations

listWorkflows(options?)

List all available workflows.

executeWorkflow(name, input?, options?)

Execute a workflow by name.

getWorkflowStatus(runId)

Get the status of a workflow run with per-step details.

Elicitation

onElicitation(handler)

Register handler for elicitation requests.

submitElicitationResult(elicitId, response)

Submit elicitation response.

Lifecycle

close()

Close the client connection.

Usage Examples

Testing Tools

OpenAI Integration

Skill Workflow

With Authentication

Scope Caching

Connection functions use WeakMap caching to ensure singleton scopes:

FrontMcpInstance

Server bootstrap

Testing Overview

Testing guide

Runtime Modes

Deployment modes

Skills

Skills documentation