Skip to main content
Glama
fauguste

boondmanager-mcp-server

by fauguste
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Reporting sociétés

boond_reporting_companies
Read-onlyIdempotent

Calculate aggregated company metrics like revenue, margin, and activity for a date range and filter scope. Get totals instead of raw records.

Instructions

Reporting des sociétés (CA, marge, activité...).

Quand : pour obtenir des agrégats (CA, marge, taux, volumes) sur un périmètre et une période. Plutôt que : boond_companies_search pour la liste des enregistrements eux-mêmes : ce reporting renvoie des totaux calculés, pas les lignes qui les composent.

Filtres clés : périmètre (perimeterDynamic / perimeterManagers / perimeterAgencies…), période (period, periodDynamic), companiesStates, companies, maxCompanies, showPercentage.

  • ⚠️ startDate + endDate (YYYY-MM-DD) sont REQUIS : l'API répond 422 sans eux.

  • Sans filtre de périmètre, l'agrégation porte sur tout le périmètre autorisé du compte — un total « entreprise » là où l'utilisateur attendait souvent son équipe.

  • Les états et types sont des ID entiers du dictionnaire (boond_application_dictionary), pas des libellés.

  • Une agrégation large peut durer plusieurs dizaines de secondes ; l'avancement est signalé via notifications/progress quand le client fournit un progressToken.

Returns : tableau d'indicateurs agrégés, rendu en texte. Lecture seule.

  • Pagination : pageSize 1–500 (défaut 30), page 1–100 — au-delà : refus, affiner les filtres.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoNuméro de page (défaut: 1, max: 100)
endDateYesDate de fin (YYYY-MM-DD). Requis par l'API.
keywordsNoMots-clés.
pageSizeNoNombre de résultats par page (max: 500, défaut: 30)
useCacheNoCache de reporting : 'withCache' (valeurs mises en cache) ou 'withoutCache' (recalcul, défaut).
companiesNoFiltrer sur ces IDs de sociétés.
startDateYesDate de début (YYYY-MM-DD). Requis par l'API.
scorecardsNoIDs des scorecards (indicateurs) à retourner.
maxCompaniesNoNombre de sociétés par page (1-10, défaut 1). Le nombre de résultats = sociétés × indicateurs.
periodDynamicNoPériode dynamique relative à aujourd'hui (avec period='dynamicPeriod') : today, thisWeek, thisMonth, thisTrimester, thisSemester, thisYear, thisFiscalYear, yesterday, lastWeek, lastMonth, lastTrimester, lastSemester, lastYear, lastFiscalYear, tomorrow, nextWeek, nextMonth, nextTrimester, nextSemester, nextYear, nextFiscalYear, lastCustomPeriod, nextCustomPeriod.
perimeterPolesNoIDs de pôles. Conserve les entités dont le responsable appartient à ces pôles.
showPercentageNoAfficher les valeurs en pourcentage plutôt qu'en valeur réelle.
companiesStatesNoIDs d'états de sociétés (dictionnaire setting.state.company).
narrowPerimeterNoSi true, jointure ET entre les filtres `perimeter*` (au lieu de OU par défaut).
perimeterDynamicNoPérimètre dynamique relatif à l'utilisateur courant (raccourci sans avoir à connaître son propre ID). Valeurs : 'data' (mes propres données), 'managers' (mon équipe / mes N-1), 'agencies' (mes agences), 'poles' (mes pôles), 'businessUnits' (mes BU). Combinable.
perimeterAgenciesNoIDs d'agences. Conserve les entités dont le responsable appartient à ces agences.
perimeterManagersNoIDs des managers (ressources). Conserve les entités dont le responsable est l'un de ces managers. Pour 'mon équipe / N-1 d'une personne X', passer [X_id]. Obtenir son propre ID via boond_application_current_user.
perimeterBusinessUnitsNoIDs de business units. Conserve les entités dont le responsable appartient à ces BU.
periodDynamicParametersNoParamètres de la période personnalisée (utilisé avec periodDynamic=lastCustomPeriod/nextCustomPeriod).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.12.2
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
  2. Changed17 schema fields changedv2.7.0
    • addedInput schema / properties / companies
      Added value: +{
+  "description": "Filtrer sur ces IDs de sociétés.",
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / companiesStates
      Added value: +{
+  "description": "IDs d'états de sociétés (dictionnaire setting.state.company).",
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}
    • changedInput schema / properties / endDate / description
      Previous value: -"Date de fin YYYY-MM-DD. Requis."New value: +"Date de fin (YYYY-MM-DD). Requis par l'API."
    • addedInput schema / properties / maxCompanies
      Added value: +{
+  "description": "Nombre de sociétés par page (1-10, défaut 1). Le nombre de résultats = sociétés × indicateurs.",
+  "maximum": 10,
+  "minimum": 1,
+  "type": "integer"
+}
    • addedInput schema / properties / narrowPerimeter
      Added value: +{
+  "description": "Si true, jointure ET entre les filtres `perimeter*` (au lieu de OU par défaut).",
+  "type": "boolean"
+}
    • changedInput schema / properties / page / description
      Previous value: -"Numéro de page (max: 100)"New value: +"Numéro de page (défaut: 1, max: 100)"
    • addedInput schema / properties / perimeterAgencies
      Added value: +{
+  "description": "IDs d'agences. Conserve les entités dont le responsable appartient à ces agences.",
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / perimeterBusinessUnits
      Added value: +{
+  "description": "IDs de business units. Conserve les entités dont le responsable appartient à ces BU.",
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / perimeterDynamic
      Added value: +{
+  "description": "Périmètre dynamique relatif à l'utilisateur courant (raccourci sans avoir à connaître son propre ID). Valeurs : 'data' (mes propres données), 'managers' (mon équipe / mes N-1), 'agencies' (mes agences), 'poles' (mes pôles), 'businessUnits' (mes BU). Combinable.",
+  "items": {
+    "enum": [
+      "data",
+      "agencies",
+      "poles",
+      "businessUnits",
+      "managers"
+    ],
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / perimeterManagers
      Added value: +{
+  "description": "IDs des managers (ressources). Conserve les entités dont le responsable est l'un de ces managers. Pour 'mon équipe / N-1 d'une personne X', passer [X_id]. Obtenir son propre ID via boond_application_current_user.",
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / perimeterPoles
      Added value: +{
+  "description": "IDs de pôles. Conserve les entités dont le responsable appartient à ces pôles.",
+  "items": {
+    "maximum": 9007199254740991,
+    "minimum": -9007199254740991,
+    "type": "integer"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / periodDynamic
      Added value: +{
+  "description": "Période dynamique relative à aujourd'hui (avec period='dynamicPeriod') : today, thisWeek, thisMonth, thisTrimester, thisSemester, thisYear, thisFiscalYear, yesterday, lastWeek, lastMonth, lastTrimester, lastSemester, lastYear, lastFiscalYear, tomorrow, nextWeek, nextMonth, nextTrimester, nextSemester, nextYear, nextFiscalYear, lastCustomPeriod, nextCustomPeriod.",
+  "type": "string"
+}
    • addedInput schema / properties / periodDynamicParameters
      Added value: +{
+  "description": "Paramètres de la période personnalisée (utilisé avec periodDynamic=lastCustomPeriod/nextCustomPeriod).",
+  "type": "string"
+}
    • addedInput schema / properties / scorecards
      Added value: +{
+  "description": "IDs des scorecards (indicateurs) à retourner.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / showPercentage
      Added value: +{
+  "description": "Afficher les valeurs en pourcentage plutôt qu'en valeur réelle.",
+  "type": "boolean"
+}
    • changedInput schema / properties / startDate / description
      Previous value: -"Date de début YYYY-MM-DD. Requis."New value: +"Date de début (YYYY-MM-DD). Requis par l'API."
    • addedInput schema / properties / useCache
      Added value: +{
+  "description": "Cache de reporting : 'withCache' (valeurs mises en cache) ou 'withoutCache' (recalcul, défaut).",
+  "enum": [
+    "withCache",
+    "withoutCache"
+  ],
+  "type": "string"
+}
  3. First observedv2.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and the description's 'Lecture seule' is consistent with them — no contradiction. Beyond annotations, the description discloses critical runtime behavior: the 422 response without startDate/endDate, the default whole-account aggregation trap, integer dictionary IDs instead of labels, multi-second latency with progressToken signaling, and pagination refusal beyond page 100/pageSize 500. This is exactly the operational context annotations cannot provide.

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 well-structured with scannable sections ('Quand', 'Plutôt que', 'Filtres clés') and bullet-pointed warnings. For a 19-parameter reporting tool with subtle default behaviors, the length is justified — every section carries distinct value, and the critical warnings are front-loaded before pagination details.

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?

With 19 parameters and no output schema, the description is remarkably complete: it covers required parameters and their failure mode, default scope behavior, dictionary ID semantics, expected latency and progress signaling, return format ('tableau d'indicateurs agrégés, rendu en texte'), and pagination bounds. The only minor omission is where scorecard IDs originate, but the schema's field description and the dictionary reference cover the common case.

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 — the schema already documents all 19 parameters. The description adds meaningful operational semantics on top: the 422 failure without startDate/endDate, the default whole-perimeter scope trap, and the note that companiesStates values are dictionary integer IDs, not labels. Relative to baseline it elevates understanding of the most error-prone parameters without restating the schema.

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 opens with 'Reporting des sociétés (CA, marge, activité...)' naming a specific verb (reporting), resource (companies), and metric types (revenue, margin, activity). It explicitly differentiates from the sibling `boond_companies_search`, stating this tool returns 'totaux calculés, pas les lignes qui les composent' — so an agent cannot confuse aggregate totals with record lists.

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 'Quand' section states precisely when to use it — 'pour obtenir des agrégats (CA, marge, taux, volumes) sur un périmètre et une période'. The 'Plutôt que' section names `boond_companies_search` as the alternative for record lists and spells out the exclusion condition. This is explicit when/when-not guidance with a named sibling.

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

Deploy Server

Other Tools