Skip to main content
Glama

get_auth_status

Check authentication status and configuration for the QuantConnect trading platform to verify access and settings.

Instructions

Get current authentication status and configuration.

Returns: Dictionary containing authentication status information

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler function implementing the get_auth_status MCP tool. Uses get_auth_instance() to check authentication status and returns detailed status information including configuration details or setup instructions.
    @mcp.tool()
    async def get_auth_status() -> Dict[str, Any]:
        """
        Get current authentication status and configuration.
    
        Returns:
            Dictionary containing authentication status information
        """
        try:
            auth = get_auth_instance()
    
            if auth is None:
                return {
                    "status": "not_configured",
                    "authenticated": False,
                    "message": "QuantConnect authentication not configured",
                    "required_credentials": [
                        "user_id - Your QuantConnect user ID",
                        "api_token - Your QuantConnect API token",
                        "organization_id - Your organization ID (optional)",
                    ],
                    "setup_instructions": "Use configure_quantconnect_auth tool to set up credentials",
                }
    
            return {
                "status": "configured",
                "user_id": auth.user_id,
                "organization_id": auth.organization_id,
                "has_organization": auth.organization_id is not None,
                "api_base_url": auth.base_url,
                "message": "Authentication configured - use validate_quantconnect_auth to test",
            }
    
        except Exception as e:
            return {
                "status": "error",
                "error": str(e),
                "message": "Failed to get authentication status",
            }
  • Top-level registration call to register_auth_tools(mcp), which defines and registers the get_auth_status tool among other auth tools to the MCP server instance.
    safe_print("🔧 Registering QuantConnect tools...")
    register_auth_tools(mcp)
    register_project_tools(mcp)
    register_file_tools(mcp)
    register_backtest_tools(mcp)
    register_live_tools(mcp)
    register_optimization_tools(mcp)
Behavior3/5

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

With no annotations provided, the description carries the burden of behavioral disclosure. It states the tool returns a dictionary with authentication status information, which implies a read-only, non-destructive operation, but doesn't detail aspects like rate limits, error conditions, or what specific information is included (e.g., tokens, expiry). This is adequate but lacks depth for a tool with no annotation support.

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 brief and front-loaded, stating the purpose in the first sentence and the return format in the second. It avoids unnecessary words, but the second sentence could be integrated more smoothly (e.g., 'Returns a dictionary...'), making it slightly less polished.

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 (0 parameters, no annotations, but has an output schema), the description is reasonably complete. It covers what the tool does and the return type, and with an output schema, it doesn't need to detail return values. However, it could benefit from more context on authentication specifics or usage scenarios to enhance completeness.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter details, which is appropriate, but it could have mentioned any implicit inputs (e.g., context-based authentication). Since there are no parameters, a baseline of 4 is applied, as the description doesn't need to compensate for gaps.

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 ('Get') and resource ('current authentication status and configuration'), making it understandable. However, it doesn't explicitly distinguish this from sibling tools like 'get_auth_headers_info' or 'test_quantconnect_api', which might also relate to authentication, so it misses full differentiation.

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 prerequisites, context (e.g., after authorization attempts), or exclusions, leaving the agent to infer usage from the purpose alone without explicit direction.

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/taylorwilsdon/quantconnect-mcp'

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