Skip to main content
Glama

Analyze Rental Yield

analyze_rental_yield
Read-only

Estimate gross rental yield for one French commune using ANIL asking-rent indicators and clean DVF sale prices.

REQUIRED:

  • code_insee: French 5-character INSEE commune code (e.g., "33063" for Bordeaux; Corsica codes such as "2A004" are supported)

OPTIONAL:

  • type_local: "Appartement" (default) or "Maison"

  • appartement_profile: "all" (default), "t1_t2", or "t3_plus" — apartments only

Returns the latest available 24-month DVF sale window, median sale price/m², ANIL's charges-included rent/m², estimated gross yield, confidence interval, and data-quality flags.

Important: this is a commune-level estimate, not a property valuation. It excludes taxes, financing, vacancy, maintenance, and management costs. ANIL rents are unfurnished advertised rents including charges.

Cost: 10 credits per call

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "code_insee": "<code_insee>"
    },
    "name": "analyze_rental_yield"
  }
}

Input Schema

NameRequiredDescriptionDefault
code_inseeYesINSEE commune code (e.g., '33063' for Bordeaux or '2A004' in Corsica)
type_localNoProperty type (default: Appartement)Appartement
appartement_profileNoApartment profile: all (default), t1_t2 (1-2 rooms), or t3_plus (3+ rooms); filters both the ANIL rent and the DVF sales. Only applies to Appartement.all

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / appartement_profile / description
      Previous value: -"Apartment profile: all (default), t1_t2, or t3_plus. Only applies to Appartement."New value: +"Apartment profile: all (default), t1_t2 (1-2 rooms), or t3_plus (3+ rooms); filters both the ANIL rent and the DVF sales. Only applies to Appartement."
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), and the description adds substantial context beyond them: the 24-month DVF window, confidence intervals, data-quality flags, the cost of 10 credits per call, and the exact scope of exclusions (taxes, financing, vacancy, maintenance, management). It also clarifies that ANIL rents are unfurnished advertised rents including charges.

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?

Front-loaded with the core purpose, then organized into REQUIRED/OPTIONAL/RETURNS/Important blocks that are easy to scan. The parameter listing partially restates the schema, which is mild redundancy, but the caveats and cost line each earn their place.

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?

No output schema exists, yet the description enumerates the return contents (window, median price/m², rent/m², yield, confidence interval, quality flags) and states the cost and limitations. An agent has everything needed to decide and call correctly.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: it gives a concrete INSEE example, notes Corsica codes like '2A004' are supported, and clarifies that appartement_profile applies only to Appartement and filters both the ANIL rent and the DVF sales.

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?

States a specific verb and resource ('Estimate gross rental yield for one French commune') plus the data sources used (ANIL asking rents, DVF sale prices). It also explicitly distinguishes itself from a property valuation, which separates it from siblings like estimate_property_value.

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?

Gives clear context on when the output is appropriate ('commune-level estimate, not a property valuation') and what it excludes. It does not name a specific alternative tool to use for property-level valuation, so routing is implied rather than explicit.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources