🤖 AboutText: Teaching AI to Understand Your APIs ✨

🤖 AboutText: Enseñando a la IA a comprender tus API ✨

Cuando expones las API de Business Central a través del Protocolo de Contexto del Modelo (MCP), tuve una pregunta fundamental: ¿Cómo sabe la IA CUÁNDO usar tu API?

Comparando BC 27.0 con 27.1, se añadieron a las páginas APIV2 la propiedad de AboutText. Antes:

page 30017 "APIV2 - Employees"
{
    APIVersion = 'v2.0';
    EntityName = 'employee';
    // No AboutText ❌
}

BC 27.1 en adelante.

page 30017 "APIV2 - Employees"
{
    APIVersion = 'v2.0';
    EntityName = 'employee';
    AboutText = 'Manages employee master data including personal details, contact information, employment status, job titles, payroll attributes, and banking information. Supports full CRUD operations...'; // ✅ Added
}

¿Por qué este cambio? Pienso que las API deben explicarse a sí mismas para los asistentes de IA.

Por ejemplo, en primer lugar, exponemos nuestra API a través del servidor MCP de BC. Seleccionamos la página APIV2 – Empleados (30017):

Aquí está el código fuente. ¿Esa línea resaltada en amarillo? Es el contexto que le enseñarán a la IA qué hace esta API:

Ahora cuando Copilot Studio lee la configuración del MCP. Todo el texto de «AboutText» aparece como descripción de la herramienta:

Así es como decide la IA. Cuando un usuario pide «muéstrame todos los empleados», la IA lee también esta descripción y sabe que esta es la herramienta correcta.

AboutText = '[Qué gestiona] + [Qué datos incluye] + [Qué operaciones] + [Qué casos de uso] + [Qué integraciones]';

Te recomiendo visitar las páginas de APIV2 de Microsoft en BC: y la información que muestran en esta propiedad. Te ayudarán a documentar tus propias APIs.

Espero que esta información te ayude.


🤖 AboutText: Teaching AI to Understand Your APIs ✨

When you expose Business Central APIs through the Model Context Protocol (MCP), I had a fundamental question: How does AI know WHEN to use your API?

Comparing BC 27.0 with 27.1, the AboutText property was added to APIV2 pages. Before:

page 30017 "APIV2 - Employees"
{
    APIVersion = 'v2.0';
    EntityName = 'employee';
    // No AboutText ❌
}

BC 27.1 onwards.

page 30017 "APIV2 - Employees"
{
    APIVersion = 'v2.0';
    EntityName = 'employee';
    AboutText = 'Manages employee master data including personal details, contact information, employment status, job titles, payroll attributes, and banking information. Supports full CRUD operations...'; // ✅ Added
}

Why this change? I think APIs need to be self-explanatory for AI assistants.

For example, first, we expose our API through the BC MCP server. We select the APIV2 – Employees (30017) page:

Here’s the source code. That line highlighted in yellow? That’s the context that will teach the AI ​​what this API does:

Now, when Copilot Studio reads the MCP configuration, all the text from «AboutText» appears as the tool description.

This is how AI decides. When a user asks «show me all employees«, the AI ​​also reads this description and knows that this is the right tool.

AboutText = '[What it manages] + [What data it includes] + [What operations] + [What use cases] + [What integrations]';

I recommend visiting Microsoft’s APIv2 pages on BC and the information they provide in this property. They will help you document your own APIs.

I hope this information helps you.


Más información / More information:

Una respuesta a “🤖 AboutText: Teaching AI to Understand Your APIs ✨”

  1. […] 👉 Read Gerardo’s full breakdown with code examples and MCP integration details at gerardorenteria.blog […]

    Me gusta

Deja un comentario