Skip to main content
Glama
bssth
by bssth

aspro_list_entities

List entities in a module and their available methods. Use this to explore module structure and identify callable actions.

Instructions

List entities inside a given module along with the methods available on each entity.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
moduleYesModule name, e.g. 'crm', 'fin', 'task'.

Implementation Reference

  • src/index.ts:53-71 (registration)
    Registration of 'aspro_list_entities' tool via server.registerTool, with Zod schema for 'module' input and a handler that delegates to spec.listEntities().
    server.registerTool(
      "aspro_list_entities",
      {
        description:
          "List entities inside a given module along with the methods available on each entity.",
        inputSchema: {
          module: z.string().describe("Module name, e.g. 'crm', 'fin', 'task'."),
        },
      },
      async ({ module }) => {
        const entities = spec.listEntities(module);
        if (entities.length === 0) {
          return asJson({
            error: `Unknown module "${module}". Call aspro_list_modules to see all options.`,
          });
        }
        return asJson({ module, entities });
      },
    );
  • Handler function for aspro_list_entities: takes {module} parameter, calls spec.listEntities(module), returns JSON result or error if module unknown.
    async ({ module }) => {
      const entities = spec.listEntities(module);
      if (entities.length === 0) {
        return asJson({
          error: `Unknown module "${module}". Call aspro_list_modules to see all options.`,
        });
      }
      return asJson({ module, entities });
    },
  • Input schema for aspro_list_entities: a single required 'module' string parameter validated by Zod.
      inputSchema: {
        module: z.string().describe("Module name, e.g. 'crm', 'fin', 'task'."),
      },
    },
  • SpecIndex.listEntities() helper: looks up the module in the indexed modules map and returns sorted entity objects with their available methods.
    listEntities(module: string): { entity: string; methods: string[] }[] {
      const ents = this.modules.get(module);
      if (!ents) return [];
      return [...ents]
        .sort()
        .map((entity) => ({
          entity,
          methods: [...(this.entityMethods.get(`${module}/${entity}`) ?? [])].sort(),
        }));
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It states the output includes entities and methods but lacks details on pagination, ordering, limits, or any side effects. Given the simplicity, more detail would improve transparency.

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 a single sentence that conveys the tool's purpose efficiently with no wasted words. It is well-structured and front-loaded with the action and output.

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

Completeness3/5

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

The description provides a basic understanding of what the tool does, but without an output schema, it doesn't specify the format or structure of the returned data. For a tool with one parameter, this is adequate but not complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already provides a description for the parameter (module name with examples), achieving 100% coverage. The description adds no additional semantic nuance beyond what the schema offers, so it meets the baseline.

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 clearly states it lists entities within a given module and includes the methods available on each entity. This distinguishes it from siblings like aspro_list_modules (lists modules) and aspro_list_methods (lists methods for a specific entity).

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

Usage Guidelines3/5

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

No explicit guidance on when to use this tool over alternatives. The context implies using it when you need entities and their methods for a module, but no when-not or alternative scenarios are mentioned.

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/bssth/aspro-mcp'

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