Skip to main content
Glama
Unstructured-IO

Unstructured API MCP Server

Official

check_llmtxt_status

Monitor the progress and retrieve results of an llmfull.txt generation job by providing its job ID. Returns current status and completed text content.

Instructions

Check the status of an existing llmfull.txt generation job.

Args:
    job_id: ID of the llmfull.txt generation job to check

Returns:
    Dictionary containing the current status of the job and text content if completed

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
job_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function that executes the check_llmtxt_status tool. It delegates to the internal _check_job_status helper with job_type='llmfulltxt'.
    async def check_llmtxt_status(
        job_id: str,
    ) -> Dict[str, Any]:
        """Check the status of an existing llmfull.txt generation job.
    
        Args:
            job_id: ID of the llmfull.txt generation job to check
    
        Returns:
            Dictionary containing the current status of the job and text content if completed
        """
        return await _check_job_status(job_id, "llmfulltxt")
  • Registration of the check_llmtxt_status tool with the MCP server using the mcp.tool() decorator.
    mcp.tool()(check_llmtxt_status)
  • Internal helper function that performs the actual status check using the Firecrawl API, handling both job types but used by check_llmtxt_status for llmfulltxt jobs.
    async def _check_job_status(
        job_id: str,
        job_type: Firecrawl_JobType,
    ) -> Dict[str, Any]:
        """Generic function to check the status of a Firecrawl job.
    
        Args:
            job_id: ID of the job to check
            job_type: Type of job ('crawlhtml' or 'llmtxt')
    
        Returns:
            Dictionary containing the current status of the job
        """
        # Get configuration with API key
        config = _prepare_firecrawl_config()
    
        # Check if config contains an error
        if "error" in config:
            return {"error": config["error"]}
    
        try:
            # Initialize the Firecrawl client
            firecrawl = FirecrawlApp(api_key=config["api_key"])
    
            # Check status based on job type
            if job_type == "crawlhtml":
                result = firecrawl.check_crawl_status(job_id)
    
                # Return a more user-friendly response for crawl jobs
                status_info = {
                    "id": job_id,
                    "status": result.get("status", "unknown"),
                    "completed_urls": result.get("completed", 0),
                    "total_urls": result.get("total", 0),
                }
    
            elif job_type == "llmfulltxt":
                result = firecrawl.check_generate_llms_text_status(job_id)
    
                # Return a more user-friendly response for llmfull.txt jobs
                status_info = {
                    "id": job_id,
                    "status": result.get("status", "unknown"),
                }
    
                # Add llmfull.txt content if job is completed
                if result.get("status") == "completed" and "data" in result:
                    status_info["llmfulltxt"] = result["data"].get("llmsfulltxt", "")
    
            else:
                return {"error": f"Unknown job type: {job_type}"}
    
            return status_info
        except Exception as e:
            return {"error": f"Error checking {job_type} status: {str(e)}"}
  • Import of the check_llmtxt_status function from firecrawl.py for registration in the MCP server.
    from .firecrawl import (
        cancel_crawlhtml_job,
        check_crawlhtml_status,
        check_llmtxt_status,
        invoke_firecrawl_crawlhtml,
        invoke_firecrawl_llmtxt,
    )
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It mentions the tool returns a dictionary with status and text content if completed, which is helpful. However, it lacks details on error handling, rate limits, authentication needs, or whether it's a read-only operation, leaving significant behavioral gaps.

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

Conciseness5/5

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

The description is appropriately sized and front-loaded, starting with the core purpose followed by structured sections for arguments and returns. Every sentence adds value without redundancy, making it efficient and easy to parse.

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 low complexity (one parameter) and the presence of an output schema (implied by 'Returns' section), the description is reasonably complete. It covers the purpose, parameter meaning, and return value. However, it could improve by addressing behavioral aspects like error cases or usage context relative to siblings.

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 description adds meaningful context for the single parameter 'job_id' by specifying it's the 'ID of the llmfull.txt generation job to check'. Since schema description coverage is 0% (no schema descriptions provided), this compensates well, though it doesn't detail format or constraints. With 0 parameters documented in the schema, the baseline is 4.

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

Purpose4/5

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

The description clearly states the tool's purpose with a specific verb ('Check') and resource ('status of an existing llmfull.txt generation job'), making it easy to understand what the tool does. However, it doesn't explicitly differentiate from sibling tools like 'check_crawlhtml_status' or 'get_job_info', which appear to be related status-checking tools.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools like 'check_crawlhtml_status' or 'get_job_info', nor does it specify prerequisites or exclusions. Usage is implied only through the description of checking job status.

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/Unstructured-IO/UNS-MCP'

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