Document Tools
从代码注释生成API文档PDF
用三种语言从你的代码中调用此工具。
# 1) Upload each file first → returns { filePath }
curl -X POST 'https://api.elysiatools.com/upload/doc-comment-to-pdf-docs' \
-F 'file=@/path/to/sourceFile.ext'
# 2) Call the tool with the returned filePath values
curl -X POST 'https://api.elysiatools.com/zh/api/tools/doc-comment-to-pdf-docs' \
-F 'sourceText=/**
* Adds two values
* @param {number} a
* @param {number} b
*/
function add(a,b){ return a+b }' \
-F 'sourceFile=/path/to/file.ext' \
-F 'docTitle=Utility Docs' \
-F 'version=1.0.0' \
-F 'baseFontSize=12' \
-F 'pageSize=A4' \
-F 'landscape=false' \
-F 'printBackground=true' \
-F 'marginTop=18' \
-F 'marginBottom=18' \
-F 'marginLeft=18' \
-F 'marginRight=18' \
-F 'waitUntil=networkidle0' \
-F 'waitTime=0'以 JSON 形式 POST 提交输入参数。文件类型参数需先单独上传。
POST https://api.elysiatools.com/zh/api/tools/doc-comment-to-pdf-docs| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sourceText | textarea | 否 | — |
| sourceFile | file需先上传 | 否 | — |
| docTitle | text | 否 | — |
| version | text | 否 | — |
| baseFontSize | number | 否 | — |
| pageSize | select | 否 | — |
| landscape | checkbox | 否 | — |
| printBackground | checkbox | 否 | — |
| marginTop | number | 否 | — |
| marginBottom | number | 否 | — |
| marginLeft | number | 否 | — |
| marginRight | number | 否 | — |
| waitUntil | select | 否 | — |
| waitTime | number | 否 | — |
文件结果
{
"filePath": "/public/processing/randomid.ext",
"fileName": "output.ext",
"contentType": "application/octet-stream",
"size": 1024,
"metadata": {
"key": "value"
},
"error": "Error message (optional)",
"message": "Notification message (optional)"
}将此工具加入你的 Model Context Protocol 服务，让 AI 智能体可以列出并调用它。
将以下内容加入你的 MCP 客户端配置：
{
"mcpServers": {
"elysiatools-doc-comment-to-pdf-docs": {
"name": "doc-comment-to-pdf-docs",
"description": "从代码注释生成API文档PDF",
"baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=doc-comment-to-pdf-docs",
"command": "",
"args": [],
"env": {},
"isActive": true,
"type": "sse"
}
}
}连接到 SSE 端点后，列出已开放的工具：
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/list"
}通过工具 id 调用，参数由其参数表构建：
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "doc-comment-to-pdf-docs",
"arguments": {
"sourceText": "/**\n * Adds two values\n * @param {number} a\n * @param {number} b\n */\nfunction add(a,b){ return a+b }",
"sourceFile": "https://example.com/file.ext",
"docTitle": "Utility Docs",
"version": "1.0.0",
"baseFontSize": 12,
"pageSize": "A4",
"landscape": false,
"printBackground": true,
"marginTop": 18,
"marginBottom": 18,
"marginLeft": 18,
"marginRight": 18,
"waitUntil": "networkidle0",
"waitTime": 0
}
}
}有问题或反馈？请联系 [email protected]