Files
simplex-chat/packages/simplex-chat-mcp/test/e2e/mcp.test.ts
T
Evgeny @ SimpleX Chat be668564df mcp server: files, /leave and library methods (#7962)
* bots, nodejs: document chat, connection, member contact and network commands, typed commands in library

* bots, nodejs: restore apiConnect, wrap domain once, test all connect responses

* nodejs: JSDoc for new methods

* docs: plan for bot API commands and typed Node library methods

* tests: channel prepared with a domain has a verified SimpleX name

* docs: apply review fixes to the plan for bot API commands

* docs: apply second review pass to the plan for bot API commands

* docs: refer the bot API plan to the rewritten test commit

* docs: record decisions in the plan for bot API commands

* docs: plan tests of the generated Python command strings

* python: test the generated strings of the documented commands

* docs: plan for files, /leave and library methods in the MCP server

* docs: wait at stop in the MCP plan

* docs: library methods and /leave mechanics in the MCP plan

* mcp: typed library methods for chat commands

* docs: plan the message information command for bots

* mcp: /leave CHAT owner command to leave a chat at once

* docs: file servers, GIF and video choices decided in the MCP plan

* docs: file mechanics in the MCP plan

* mcp: files of received messages

* bots, nodejs: message information with the file servers for bots

* docs: plan the relay approval option of receiving files in Node

* mcp: download of received files with owner approval

* docs: name the xftp-server test helper in the files plan

* nodejs: receive files without approving unknown relays

* docs: plan the user servers command for bots

* bots, nodejs: user servers and relays by operator for bots

* nodejs: document the message information method

* docs: plan the file upload progress event for bots

* mcp: send files with owner approval, refusing private keys

* bots: file upload progress event for bots

* mcp: /leave template in the agent control chat menu

* docs: sent copies are deleted for contacts too, at sndFileCompleteXFTP

* bots: drop the file upload progress event

* docs: drop the upload progress event plan

* nodejs: document user servers and relay approval of received files

* mcp: download cards name unknown file servers after the upload

* docs: record the wait for the file description in the files plan

* mcp: fixed wait at stop for cancelled cards, without /sql

* docs: record decision C4, a fixed wait at stop, in the files plan

* ci: test the MCP server package on pull requests

* ci: state when the MCP workflow can be dispatched

* ci: run the MCP server tests when its libraries change

* mcp: log the errors of image previews and resizing

* mcp: keep files in transfer in the data folder

* mcp: restrict sent files by the real paths of refused folders

* mcp: validate the file at the send by its inode and change time

* mcp: limit ffmpeg and ffprobe to local files and no input commands

* mcp: ask the owner for unknown file servers; read approvals at creation

* mcp: name downloaded files by their ID; return paths of downloads only

* mcp: end each download with a result for the agent and the card

* mcp: show files above their sender's size limit as failed

* mcp: refuse empty files, as without file and captions too long to send

* mcp: tell the owner about failed uploads and unposted received files

* mcp: delete resized copies left by the last run at start

* mcp: name downloads and leaving in the help and greeting, align docs

* mcp: compute the download path for received files only

* mcp: send a /receive file to the owner under its name

* mcp: keep files received without a download in the chat's folder

* mcp: keep a left chat's files and delete them with /delete CHAT files

* mcp: test that sent images are resized by the core

* mcp: wait 30 minutes for a download's progress before cancelling it

* mcp: end a download as deleted only when its message is not found

* mcp: delete the copy of a /receive file whose post fails

* mcp: count the quoted content in a message's length, as the core sends it

* mcp: name received bytes, unknown-server downloads and left chat files plainly

* mcp: test refused folders, file changes and download approvals

* docs: align MCP server docs with refused folders, leaves and download waits

* mcp: move received files only in full, delete partials only of downloads

* mcp: report a received file missing from its folder as failed

* mcp: move received files of a group's member chats into its folder

* mcp: read a video's preview and duration as an MP4 or QuickTime file

* mcp: 0.2.0 on simplex-chat 7.1.0-beta.10.1

* mcp: file folders by chat type, /delete cancels downloads, files reply

* docs: MCP server specs and plan for 0.2.0

* mcp: /receive gives the agent a file, /forward sends it to the owner

* docs: MCP server specs for /receive and /forward of download cards

* docs: MCP plan records the temp folder command as a library exception

* mcp: /delete cancels resumed downloads; /forward quote fits the limit

* docs: MCP specs and plans for /forward quotes and resumed downloads

* docs: MCP specs name the source commit they are checked against

* docs: MCP PLAN states the /forward quote and move rules

* mcp: a download moves its completed file whatever its size

* mcp: /receive N all covers its card and later files, not pending ones

* docs: MCP files approval scope, reply text and README server wording

* mcp: a download approves relays only for a card naming unknown servers

* mcp: files in member chats of a group are tracked as in the main chat

* docs: MCP relay approval of downloads and files in member chats

* mcp: a rejected file gets a card again under the files approval

* docs: MCP rejected files under the files approval, README scope

* mcp: an offered file without a description gets no card or action

* docs: MCP a file without a description is not downloaded

* mcp: 0.2.0 on simplex-chat 7.1.0-beta.10.2

* ci: test the MCP server as a scope of build-linux
2026-11-06 18:38:34 +00:00

164 lines
9.5 KiB
TypeScript

import {mkdirSync, mkdtempSync, rmSync} from "fs"
import {tmpdir} from "os"
import {join} from "path"
import {T} from "@simplex-chat/types"
import {RunningServer, startServer} from "../../src/serve"
import {McpClient} from "./client"
import {captureLog, cardNumber, person, profileWithServer, received, serveOptions, startBot, textStarts, until, updated} from "./helpers"
import {SmpServer, freePort, startSmpServer} from "./smpServer"
let smpServer: SmpServer
let dir: string
let logLines: string[]
beforeAll(async () => {
smpServer = await startSmpServer()
dir = mkdtempSync(join(tmpdir(), "simplex-mcp-e2e-"))
logLines = captureLog()
}, 120_000)
afterAll(async () => {
jest.restoreAllMocks()
await smpServer?.stop()
rmSync(dir, {recursive: true, force: true})
})
test("agent with an owner, a bot and the tools", async () => {
const agentData = join(dir, "agent")
mkdirSync(agentData, {recursive: true})
await profileWithServer(smpServer.address, join(agentData, "simplex"), {displayName: "agent", fullName: "", peerType: T.ChatPeerType.Bot})
const {chat: alice, user: aliceUser} = await person(smpServer.address, join(dir, "alice"), "Alice")
const {chat: directory, user: directoryUser, link: directoryLink} = await startBot(smpServer.address, join(dir, "directory"), "Directory", {welcomeMessage: "Welcome! Send /help or a search."})
const port = await freePort()
let server: RunningServer | undefined
try {
server = await startServer(serveOptions(agentData, port))
const client = new McpClient(`http://127.0.0.1:${port}/mcp`, server.token)
expect(logLines).toContain('Agent control chat "agent" created.')
const link = logLines.find(line => /^(https:\/\/|simplex:)/.test(line))!
expect(link).toBeDefined()
expect(logLines).toContain(`Whoever joins by this link becomes an owner of "agent" and approves its actions. To approve owners yourself, start with --owners.`)
const noOwner = await client.tool("connect", {target: directoryLink})
expect(noOwner).toMatchObject({isError: true, text: "The agent has no owner. The person who runs it has to join its control chat with the link the server printed."})
const greeting = received(alice, textStarts("I'm your agent."))
const [, controlLink] = await alice.apiConnectPlan(aliceUser.userId, link)
await alice.apiConnect(aliceUser.userId, false, controlLink)
const control = (await greeting).chatInfo as T.ChatInfo.Group
const controlId = control.groupInfo.groupId
await until(() => logLines.some(line => /^Alice joined \(member \d+\) and is now an owner\. The link is deleted\.$/.test(line)))
expect(logLines).toContain(" npx -y @simplex-chat/mcp register agent --data " + agentData)
const ownerSends = (text: string) => alice.apiSendTextMessage([T.ChatType.Group, controlId], text)
expect(await client.initialize()).toMatchObject({protocolVersion: "2025-11-25", serverInfo: {name: "simplex-mcp"}})
const {tools} = await client.request("tools/list")
expect(tools.map(({name}: {name: string}) => name)).toEqual(["connect", "send", "receive", "download", "list", "leave"])
const connectCard = received(alice, textStarts("I want to connect to bot Directory, as myself."))
const connecting = client.tool("connect", {target: directoryLink, idle: 2})
const card1 = await connectCard
expect(card1.chatItem.meta.itemText).toContain("`Find groups and bots.`")
expect(card1.chatItem.meta.itemText).toContain("`Welcome! Send /help or a search.`")
const n1 = cardNumber(card1)
const connectedCard = updated(alice, ci => ci.chatItem.meta.itemId === card1.chatItem.meta.itemId && ci.chatItem.meta.itemText.startsWith("I connected to bot Directory"))
await ownerSends(`/approve ${n1}`)
const connected = await connecting
expect(connected.isError).toBeUndefined()
expect(connected.result).toMatchObject({action: n1, status: "done", connected: true, type: "contact", name: "Directory", peer_type: "bot"})
expect(connected.result.commands).toEqual([{keyword: "help", label: "Help"}])
expect((await connectedCard).chatItem.meta.itemText.split("\n").at(-1)).toBe("Approved by Alice.")
const chat = connected.result.chat as string
expect(chat).toMatch(/^@\d+$/)
const known = await client.tool("connect", {target: directoryLink})
expect(known.result).toMatchObject({status: "known", chat, connected: true})
const sendCard = received(alice, textStarts("I want to send a message to bot Directory:"))
const sending = client.tool("send", {chat, text: "trail shoes", idle: 2, wait: 30})
const card2 = await sendCard
expect(card2.chatItem.meta.itemText).toContain("`trail shoes`")
await ownerSends(`/approve ${cardNumber(card2)}`)
const sent = await sending
expect(sent.result).toMatchObject({action: cardNumber(card2), status: "done", chat, more: 0})
expect(sent.result.responses.map(({text}: {text: string}) => text)).toEqual(["result 1: trail shoes", "result 2: trail shoes"])
expect(sent.result.responses.every(({item}: {item: number}) => item > sent.result.item)).toBe(true)
const helpCard = received(alice, textStarts("I want to send a message to bot Directory:"))
const helping = client.tool("send", {chat, text: "/help", idle: 2, wait: 30})
await ownerSends(`/approve ${cardNumber(await helpCard)}`)
expect((await helping).result.responses.map(({text}: {text: string}) => text)).toEqual(["Send a search, for example: trail shoes"])
const agentContact = (await directory.apiListContacts(directoryUser.userId)).find(({profile}) => profile.displayName === "agent")!
const receiving = client.tool("receive", {chat, wait: 30})
await new Promise(resolve => setTimeout(resolve, 500))
await directory.apiSendTextMessage([T.ChatType.Direct, agentContact.contactId], "news: new trail groups")
const news = await receiving
expect(news.result).toMatchObject({chat, more: 0})
expect(news.result.messages.map(({text}: {text: string}) => text)).toEqual(["news: new trail groups"])
expect((await client.tool("receive", {chat})).result).toEqual({chat, messages: [], more: 0})
const rejectCard = received(alice, textStarts("I want to send a message to bot Directory:"))
const rejecting = client.tool("send", {chat, text: "not this one"})
const card3 = await rejectCard
const rejectedCard = updated(alice, ci => ci.chatItem.meta.itemId === card3.chatItem.meta.itemId)
await ownerSends(`/reject ${cardNumber(card3)}`)
expect((await rejecting).result).toEqual({action: cardNumber(card3), status: "rejected"})
expect((await rejectedCard).chatItem.meta.itemText.split("\n").at(-1)).toBe("Rejected by Alice.")
const notPending = received(alice, textStarts(`Action ${cardNumber(card3)} is not pending.`))
await ownerSends(`/approve ${cardNumber(card3)}`)
await notPending
const lostCard = received(alice, textStarts("I want to send a message to bot Directory:"))
const abort = new AbortController()
const lost = client.tool("send", {chat, text: "lost result", idle: 2}, abort.signal)
const card4 = await lostCard
const n4 = cardNumber(card4)
abort.abort()
await expect(lost).rejects.toThrow()
await until(() => server!.actions.get(n4)!.open === 0)
const listed = await client.tool("list", {})
expect(listed.result.actions).toEqual([{action: n4, tool: "send", input: {chat, text: "lost result", idle: 2}, state: "pending", open: false}])
expect(listed.result.chats).toEqual([
expect.objectContaining({chat, type: "contact", name: "Directory", connected: true, incognito: false, unread: 0}),
expect.objectContaining({type: "contact", name: "Ask SimpleX Team", connected: false}),
])
await ownerSends(`/approve ${n4}`)
await until(() => server!.actions.get(n4)!.state === "done")
const attached = await client.tool("send", {chat, text: "lost result", idle: 2})
expect(attached.result).toMatchObject({action: n4, status: "done", more: 0})
expect(attached.result.responses.map(({text}: {text: string}) => text)).toEqual(["result 1: lost result", "result 2: lost result"])
expect((await client.tool("list", {})).result.actions).toEqual([])
const unknown = await client.tool("send", {chat: "#999", text: "x"})
expect(unknown).toMatchObject({isError: true, text: "No chat #999. list shows the agent's chats."})
const pendingCard = received(alice, textStarts("I want to send a message to bot Directory:"))
void client.tool("send", {chat, text: "at the stop"}).catch(() => undefined)
const card5 = await pendingCard
const n5 = cardNumber(card5)
const cancelledCard = updated(alice, ci => ci.chatItem.meta.itemId === card5.chatItem.meta.itemId)
await server.stop()
server = undefined
expect(logLines).toContain("Cancelled 1 action.")
expect(logLines).toContain("Stopping: sending 1 cancelled card, up to 10 s. Ctrl-C to stop now.")
expect(logLines).toContain("Stopped.")
expect((await cancelledCard).chatItem.meta.itemText.split("\n").at(-1)).toBe("Cancelled: the server stopped.")
server = await startServer(serveOptions(agentData, port))
const refused = received(alice, textStarts(`Action ${n5} is not pending.`))
await ownerSends(`/approve ${n5}`)
await refused
const restartedCard = received(alice, textStarts("I want to send a message to bot Directory:"))
void client.tool("send", {chat, text: "after the restart"}).catch(() => undefined)
expect(cardNumber(await restartedCard)).toBe(n5 + 1)
} finally {
await server?.stop()
await alice.close()
await directory.close()
}
}, 600_000)