Skip to main content
Glama
zagushka

Foundry REST API MCP

by zagushka

foundry_get_entity

Read-only

Retrieve any Foundry document by its UUID, such as an actor or item, to access its data for world management and encounters.

Instructions

Get one Foundry document by UUID, such as Actor.abc123.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidNo
actorNo
userIdNoOptional Foundry user ID or username for permission-scoped access.
clientIdNoFoundry client ID; defaults to FOUNDRY_CLIENT_ID.
selectedNo
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds the UUID-based retrieval scope but doesn't disclose pagination, return format, or behavior with invalid UUIDs. It's consistent with annotations, no contradiction.

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?

A single sentence, only 10 words, immediately front-loads the tool's purpose. Every word earns its place.

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?

For a simple get-by-id tool with readOnlyHint and no output schema, the description covers the core purpose. However, with 5 optional parameters and no output schema, additional details about return values or parameter relationships would be helpful. It's minimally viable but not comprehensive.

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

Parameters2/5

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

Schema description coverage is only 40%, with uuid, actor, and selected lacking descriptions. The description adds minimal context by indicating uuid is the document identifier, but it doesn't explain the boolean parameters or permission-related usage beyond what the schema already says for userId/clientId. The description should compensate more given the low coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly uses the verb 'Get' with resource 'one Foundry document' and method 'by UUID', giving an example 'Actor.abc123'. It distinguishes from siblings like foundry_get_scenes or foundry_search, though it doesn't explicitly define what 'entity' includes.

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?

The description implies using this tool when you have a specific UUID and need a single document, but it doesn't explicitly state when not to use it or mention alternatives like foundry_search for broader queries. Context signals list many sibling tools, but no guidance is provided.

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/zagushka/foundry-rest-api-mcp'

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