get_api_reference

Get Backstage API reference including REST endpoints, GraphQL, and client libraries

Server Backstage MCP Server pawelwaj/mcp
Category Read
Risk class Low
Parameters 00 required

What get_api_reference does on Backstage MCP Server

AI agents call get_api_reference to retrieve information from Backstage MCP Server without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

Why get_api_reference needs a policy

This tool retrieves and queries existing API reference documentation. It performs a read-only operation to fetch information about endpoints, GraphQL schemas, and client library documentation. There is no data modification, code execution, deletion, or financial impact. The blast radius of misuse is minimal—an agent could only access publicly documented API information.

From the tool's definition Tool name 'get_api_reference' and description 'Get Backstage API reference including REST endpoints, GraphQL, and client libraries' indicates retrieval of documentation/reference material with no side effects.

Questions about get_api_reference

What does the get_api_reference tool do? +

Get Backstage API reference including REST endpoints, GraphQL, and client libraries. It is categorised as a Read tool in the Backstage MCP Server MCP Server, which means it retrieves data without modifying state.

How do I enforce a policy on get_api_reference? +

Register the Backstage MCP Server MCP server in PolicyLayer and add a rule for get_api_reference: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Backstage MCP Server. Nothing to install.

What risk level is get_api_reference? +

get_api_reference is a Read tool with low risk. Read-only tools are generally safe to allow by default.

Can I rate-limit get_api_reference? +

Yes. Add a rate_limit block to the get_api_reference rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block get_api_reference completely? +

Set action: deny in the PolicyLayer policy for get_api_reference. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides get_api_reference? +

get_api_reference is provided by the Backstage MCP Server MCP server (pawelwaj/mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// LOOK UP ANOTHER SERVER

Every MCP server has a record like this.

Type a name, get the same breakdown: verified identity, auth posture, risk grade, capabilities, recommended policy.

Teams ship this data inside their own products. See what a licence covers →

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.