/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Test MCP Server

Test MCP Server

Check that the project's MCP server answers, and how many tools it offers.

POST/v1/projects/{projectId}/addons/mcp_server/testTry it
Session token

Checks that the project's MCP server is up: Syntext resolves it the way its public endpoint does and lists its tools, and tells you how many it offers and how long that took.

Note

Session JWT and org membership required. Any role can run the test — an API key gets 401, a non-member 403. Any plan.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

No request body.

Response — 200 OK

The test always answers 200; read ok. When it fails, tools is 0 and error says why:

Response Fields

NameDescription
data.ok:boolean
true when the server resolved and listed its tools.
data.tools:integer
How many tools tools/list advertises — the number of enabled: true rows in List MCP Server Tools.
data.latencyMs:integer
How long resolving and listing took, in milliseconds.
data.error:string | null
null on success. Otherwise The MCP server add-on is not enabled for this project or The MCP server could not list its tools.
Note

The test runs inside Syntext rather than calling your doc site's /_mcp URL, so it does not check your domain or DNS — only that the server behind them works. latencyMs therefore does not include network time.

Error Responses

401 Unauthorized

Missing, invalid or expired session JWT, or an API key.

403 Forbidden

You are not a member of the organization that owns the project.

404 Not Found

The project does not exist or has been deleted.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X POST https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/addons/mcp_server/test \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200jsonOK
{
"data": {
"ok": true,
"tools": 3,
"latencyMs": 42,
"error": null
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext