Skip to main content
Glama

list_policies

Retrieve all IAM policies within a specified Oracle Cloud Infrastructure compartment to manage access control and permissions.

Instructions

List all IAM policies in a compartment.

Args:
    compartment_id: OCID of the compartment to list policies from

Returns:
    List of policies with their statements and state

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
compartment_idYes

Implementation Reference

  • MCP tool handler for 'list_policies': async function decorated with @mcp.tool that processes the request, uses the shared OCI identity client, calls the helper function, and returns formatted policy list.
    @mcp.tool(name="list_policies")
    @mcp_tool_wrapper(
        start_msg="Listing IAM policies in compartment {compartment_id}...",
        error_prefix="Error listing policies"
    )
    async def mcp_list_policies(ctx: Context, compartment_id: str) -> List[Dict[str, Any]]:
        """
        List all IAM policies in a compartment.
    
        Args:
            compartment_id: OCID of the compartment to list policies from
    
        Returns:
            List of policies with their statements and state
        """
        return list_policies(oci_clients["identity"], compartment_id)
  • Core helper function implementing the OCI API call to list policies using pagination, extracts and formats policy details into list of dicts.
    def list_policies(identity_client: oci.identity.IdentityClient, compartment_id: str) -> List[Dict[str, Any]]:
        """
        List all policies in a compartment.
        
        Args:
            identity_client: OCI Identity client
            compartment_id: OCID of the compartment
            
        Returns:
            List of policies with their details
        """
        try:
            policies_response = oci.pagination.list_call_get_all_results(
                identity_client.list_policies,
                compartment_id
            )
            
            policies = []
            for policy in policies_response.data:
                policies.append({
                    "id": policy.id,
                    "name": policy.name,
                    "description": policy.description,
                    "statements": policy.statements,
                    "version_date": str(policy.version_date) if policy.version_date else None,
                    "lifecycle_state": policy.lifecycle_state,
                    "time_created": str(policy.time_created),
                    "compartment_id": policy.compartment_id,
                })
            
            logger.info(f"Found {len(policies)} policies in compartment {compartment_id}")
            return policies
            
        except Exception as e:
            logger.exception(f"Error listing policies: {e}")
            raise
  • Import statement registering the list_policies helper function for use in the MCP tool handler.
    from mcp_server_oci.tools.identity import (
        list_users,
        get_user,
        list_groups,
        get_group,
        list_policies,
        get_policy,
        list_dynamic_groups,
        get_dynamic_group,
    )
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the return format ('List of policies with their statements and state'), which adds some value, but fails to cover critical aspects like pagination, rate limits, authentication requirements, or error handling for a list operation in a cloud environment.

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 efficiently structured with a clear purpose statement followed by Args and Returns sections. Every sentence adds value without redundancy, making it easy to parse and understand quickly.

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 list tool with no annotations and no output schema, the description is adequate but has gaps. It covers the basic operation and parameter semantics, but lacks details on behavioral traits like pagination or error handling, which are important for an IAM policy listing in a cloud context.

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

Parameters4/5

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

The description adds meaningful context for the single parameter ('compartment_id: OCID of the compartment to list policies from'), explaining its purpose beyond the schema's basic title. Since schema description coverage is 0%, this compensates well, though it doesn't detail format constraints like OCID structure or validation rules.

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 states the verb ('List') and resource ('all IAM policies in a compartment'), making the purpose specific and understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_policy' or other list tools, which slightly limits its clarity in a crowded toolset.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'get_policy' or other list tools. It lacks context on prerequisites, such as required permissions or compartment structure, and doesn't mention any exclusions or specific use cases.

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/jopsis/mcp-server-oci'

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