Skip to main content
Glama
cmendezs

mcp-facture-electronique-fr

healthcheck_flow

Check the operational status of the Approved Platform's Flow Service before submitting invoices. Returns ok, degraded, or unavailable.

Instructions

Check the availability of the Approved Platform's Flow Service. Returns the operational status of the service (ok/degraded/unavailable). Use before an invoice submission session to ensure the AP is reachable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The MCP tool handler for 'healthcheck_flow'. Calls get_flow_client() and then client.healthcheck() to check AP Flow Service availability.
    @mcp.tool()
    async def healthcheck_flow() -> dict:
        """
        Check the availability of the Approved Platform's Flow Service.
        Returns the operational status of the service (ok/degraded/unavailable).
        Use before an invoice submission session to ensure the AP is reachable.
        """
        client = get_flow_client()
        return await client.healthcheck()
  • The HTTP client method (FlowClient.healthcheck) that performs the actual GET /v1/healthcheck request to the Approved Platform.
    async def healthcheck(self) -> dict[str, Any]:
        """GET /v1/healthcheck — Check Flow Service availability."""
        response = await self._request("GET", "/v1/healthcheck")
        try:
            return response.json()
        except Exception:
            return {"status": "ok", "http_status": response.status_code}
  • The tool is registered via the @mcp.tool() decorator in register_flow_tools(), which is called from server.py line 74.
    @mcp.tool()
    async def healthcheck_flow() -> dict:
        """
        Check the availability of the Approved Platform's Flow Service.
        Returns the operational status of the service (ok/degraded/unavailable).
        Use before an invoice submission session to ensure the AP is reachable.
        """
        client = get_flow_client()
        return await client.healthcheck()
  • Singleton helper that creates and caches the FlowClient instance used by healthcheck_flow.
    def get_flow_client() -> FlowClient:
        global _flow_client
        if _flow_client is None:
            _flow_client = FlowClient()
        return _flow_client
Behavior4/5

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

No annotations are provided, so the description carries full burden. It states the tool returns operational status (ok/degraded/unavailable), which is transparent about the output and non-destructive nature. It does not cover error behavior or rate limits, but the core behavior is clear.

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?

Two sentences: first states purpose, second states return value and usage context. No redundant information, highly efficient.

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

Completeness5/5

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

For a simple health check with zero parameters and an output schema (implied by context signals), the description provides all needed information: what it does, what it returns, and when to use it.

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 zero parameters, so the description does not need to add parameter info. Schema coverage is 100% vacuously, and baseline for 0 parameters is 4.

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 explicitly states the tool checks availability of the Flow Service, using a specific verb and resource. No sibling tool has a health-check function, so it is clearly distinguished.

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

Usage Guidelines4/5

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

The description says 'Use before an invoice submission session to ensure the AP is reachable,' providing a clear use case. It does not mention when not to use, but the context is sufficient.

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/cmendezs/mcp-facture-electronique-fr'

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