Skip to main content
Glama
Alex-Smith-1234

讯飞智文PPT生成服务MCP Server

get_task_progress

Check the status of PowerPoint generation tasks and retrieve download links when completed. Use this tool to monitor progress for presentations created through the iFlytek PPT service.

Instructions

查询PPT生成任务进度。

使用说明:
1. 用于查询通过create_ppt_task或create_ppt_by_outline创建的任务进度。
2. 需定期轮询本工具直到任务完成。
3. 任务完成后,可从返回结果中获取PPT下载地址。
4. 需先设置环境变量AIPPT_APP_ID和AIPPT_API_SECRET。

参数:
- sid: 任务ID,从create_ppt_task或create_ppt_by_outline工具获取。

返回:
包含任务状态和PPT下载地址的字典。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sidYes

Implementation Reference

  • The main handler function for the 'get_task_progress' tool. It takes a task ID (sid) and queries the progress from the xfyun API, returning the raw response text which includes status and download URL when complete. The function signature and docstring provide the input schema.
    @mcp.tool()
    def get_task_progress(
        ctx: Context,
        sid: str
    ) -> Dict[str, Any]:
        """
        查询PPT生成任务进度。
        
        使用说明:
        1. 用于查询通过create_ppt_task或create_ppt_by_outline创建的任务进度。
        2. 需定期轮询本工具直到任务完成。
        3. 任务完成后,可从返回结果中获取PPT下载地址。
        4. 需先设置环境变量AIPPT_APP_ID和AIPPT_API_SECRET。
        
        参数:
        - sid: 任务ID,从create_ppt_task或create_ppt_by_outline工具获取。
        
        返回:
        包含任务状态和PPT下载地址的字典。
        """
        url = f"https://zwapi.xfyun.cn/api/ppt/v2/progress?sid={sid}"
        headers = get_headers()
        response = requests.get(url, headers=headers)
    
        if response.status_code != 200:
            raise Exception(f"调用失败: {response.text}")
        
        return response.text
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes the polling behavior ('需定期轮询本工具直到任务完成'), the expected outcome ('任务完成后,可从返回结果中获取PPT下载地址'), and authentication requirements ('需先设置环境变量AIPPT_APP_ID和AIPPT_API_SECRET'). It doesn't mention rate limits or error handling, but covers the essential behavioral traits for this type of progress-checking tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, usage instructions, parameters, returns) and each sentence earns its place. It could be slightly more concise by combining some points, but the information density is high and the structure facilitates understanding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (polling progress checker), no annotations, and no output schema, the description provides good completeness. It covers purpose, usage flow, prerequisites, parameter meaning, and expected return content. The main gap is the lack of output schema details, but the description compensates by describing the return format ('包含任务状态和PPT下载地址的字典').

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must compensate. It provides clear semantic meaning for the single parameter 'sid', explaining it's a task ID obtained from specific sibling tools (create_ppt_task or create_ppt_by_outline). This adds significant value beyond what the bare schema provides, though it doesn't specify format constraints or examples.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific verb ('查询' meaning 'query') and resource ('PPT生成任务进度' meaning 'PPT generation task progress'), distinguishing it from sibling tools like create_ppt_task or get_theme_list. It explicitly identifies the tool's purpose as checking progress for PPT generation tasks.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidelines: it specifies when to use (for tasks created by create_ppt_task or create_ppt_by_outline), when to stop (poll until task completion), prerequisites (environment variables AIPPT_APP_ID and AIPPT_API_SECRET), and what to expect after completion (PPT download address). This covers both usage context and exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Alex-Smith-1234/zwppt-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server