getmetadataobjects
July 31, 2026 · View on GitHub
Get a flat list of 1C configuration metadata objects (Name, Synonym, Comment, Type, ObjectModule, ManagerModule) as a Markdown table. Use it to discover what objects exist; filter by metadataType and/or nameFilter (Name only). Use this to list objects; for the full properties of one named object use get_metadata_details. Full parameters and examples: call get_tool_guide('get_metadata_objects').
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| projectName | yes | string | EDT project name (required) |
| metadataType | — | string | Type filter (case-insensitive), default 'all'. Accepts EITHER a category token - all, documents, catalogs, informationRegisters, accumulationRegisters, commonModules, enums, constants, reports, dataProcessors, exchangePlans, businessProcesses, tasks, commonAttributes, eventSubscriptions, scheduledJobs, xdtoPackages - OR a single standard metadata type name (the FQN token, English or its Russian equivalent, e.g. 'ScheduledJob', 'Document'). Single value only - not an array. An unrecognized value returns an error listing the supported options. |
| nameFilter | — | string | Case-insensitive substring matched against Name only (not Synonym) |
| limit | — | integer | Max rows (default from preferences: 100, max 1000) |
| language | — | string | Synonym language code, e.g. 'en'/'ru' (default: configuration default) |
Guide
List the metadata objects of a 1C configuration as a flat Markdown table. Each row carries the object Name, its Synonym in the chosen language, Comment, the metadata Type, and two flags - ObjectModule and ManagerModule - that show whether the object owns the corresponding module (Yes/-).
When to use
- Discover what objects exist in a configuration before drilling into one.
- Find an object by a partial Name (
nameFilter) or narrow to a single kind (metadataType). - To inspect one object's attributes/forms/etc., follow up with
get_metadata_detailsusing the Name and Type from this table.
Parameter details
-
projectName(required) - EDT project name. -
metadataType- which kind to list; defaultall. Matching is case-insensitive, and it's a single string, not an array. Accepts EITHER form:- a category token:
all,documents,catalogs,informationRegisters,accumulationRegisters,commonModules,enums,constants,reports,dataProcessors,exchangePlans,businessProcesses,tasks,commonAttributes,eventSubscriptions,scheduledJobs,xdtoPackages; - OR a standard metadata type name - the same FQN token used elsewhere in the API, English or its Russian equivalent (e.g.
ScheduledJob,Document,Справочник). This is the natural form to reach for; it maps onto the category above internally.
An unrecognized value (including a type name this tool has no collector for, e.g.
Subsystem) returns an error naming the bad value and listing the supported categories. Note the parameter ismetadataType(a single value) - there is notypesarray parameter. - a category token:
-
nameFilter- case-insensitive substring matched against the object Name only, never the Synonym. Omit to list everything of the chosen type. -
limit- max rows returned; default from preferences (100), clamped to 1000. A truncation notice is appended when results are capped, while Total still reports the full count. -
language- language code for the Synonym column (e.g.en,ru). Defaults to the configuration's default language.
Columns
Name- the programmatic object name (use this with other tools).Synonym- localized caption for the chosenlanguage.Comment- the object's comment, if any.Type- e.g.Document,Catalog,InformationRegister,CommonModule,Enum.ObjectModule-Yesif the object has an object/record-set/value-manager module, else-.ManagerModule-Yesif the object has a manager module, else-.
Examples
- Everything:
{projectName: "MyProject"}. - Only documents:
{projectName: "MyProject", metadataType: "documents"}. - Only scheduled jobs, via the type-name token:
{projectName: "MyProject", metadataType: "ScheduledJob"}(equivalent tometadataType: "scheduledJobs"). - Only XDTO packages:
{projectName: "MyProject", metadataType: "xdtoPackages"}(or the type nameXDTOPackage/ПакетXDTO). This is how you get theXDTOPackage.<Name>FQN the XDTO tools need -create_metadata/modify_metadata/delete_metadataon a package member, andvalidate_xdto_package. - Filter by name:
{projectName: "MyProject", nameFilter: "Order"}. - Russian synonyms:
{projectName: "MyProject", language: "ru"}.
Notes & gotchas
nameFiltermatches the programmatic Name, never the localized synonym; searching by a translated caption will not match.- The Synonym is keyed by language code (
en/ru), not the language's display name; an unconfigured language yields an empty synonym, not an error. - Output is Markdown; table cells are escaped so a
|in a comment or synonym does not break the table.
Generated from the live MCP server (get_tool_guide) by docs/generate_tool_docs.py. Do not edit this file. Edit the tool's description/schema in its Java source and its guide body in mcp/bundles/com.ditrix.edt.mcp.server/guides/<tool>.md.